tencentcloud-sdk-nodejs-ess 4.0.674 → 4.0.676
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 +461 -0
- package/SERVICE_CHANGELOG.md +554 -73
- package/package.json +1 -1
- package/products.md +29 -29
- package/src/services/ess/v20201111/ess_client.ts +75 -28
- package/src/services/ess/v20201111/ess_models.ts +533 -296
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +44 -15
- package/tencentcloud/services/ess/v20201111/ess_client.js +49 -16
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +520 -289
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse,
|
|
2
|
+
import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, DescribeIntegrationMainOrganizationUserRequest, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateChannelSubOrganizationModifyQrCodeRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateChannelSubOrganizationModifyQrCodeResponse, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
|
|
3
3
|
/**
|
|
4
4
|
* ess client
|
|
5
5
|
* @class
|
|
@@ -59,15 +59,24 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
59
59
|
*/
|
|
60
60
|
CreateUserAutoSignEnableUrl(req: CreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CreateUserAutoSignEnableUrlResponse) => void): Promise<CreateUserAutoSignEnableUrlResponse>;
|
|
61
61
|
/**
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
62
|
+
* 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
|
|
63
|
+
|
|
64
|
+
适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
|
|
65
|
+
|
|
66
|
+
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。
|
|
67
|
+
适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
68
|
+
|
|
69
|
+
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
70
|
+
|
|
71
|
+
注意事项:SaaS角色和集团角色对应的权限树是不一样的。
|
|
72
|
+
*/
|
|
73
|
+
CreateIntegrationRole(req: CreateIntegrationRoleRequest, cb?: (error: string, rep: CreateIntegrationRoleResponse) => void): Promise<CreateIntegrationRoleResponse>;
|
|
65
74
|
/**
|
|
66
75
|
* 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
|
|
67
76
|
*/
|
|
68
77
|
CreateEmbedWebUrl(req: CreateEmbedWebUrlRequest, cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void): Promise<CreateEmbedWebUrlResponse>;
|
|
69
78
|
/**
|
|
70
|
-
*
|
|
79
|
+
* 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
|
|
71
80
|
*/
|
|
72
81
|
VerifyPdf(req: VerifyPdfRequest, cb?: (error: string, rep: VerifyPdfResponse) => void): Promise<VerifyPdfResponse>;
|
|
73
82
|
/**
|
|
@@ -142,6 +151,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
142
151
|
- 模板中配置的签署顺序是无序
|
|
143
152
|
- B端企业的签署方式是静默签署
|
|
144
153
|
- B端企业是非首位签署
|
|
154
|
+
|
|
155
|
+
通过一码多扫二维码发起的合同,涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)
|
|
156
|
+
|
|
157
|
+
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
|
|
145
158
|
*/
|
|
146
159
|
CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
|
|
147
160
|
/**
|
|
@@ -183,6 +196,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
183
196
|
生成子客编辑企业信息二维码
|
|
184
197
|
*/
|
|
185
198
|
CreateChannelSubOrganizationModifyQrCode(req: CreateChannelSubOrganizationModifyQrCodeRequest, cb?: (error: string, rep: CreateChannelSubOrganizationModifyQrCodeResponse) => void): Promise<CreateChannelSubOrganizationModifyQrCodeResponse>;
|
|
199
|
+
/**
|
|
200
|
+
* 此接口(UploadFiles)用于文件上传。<br/>
|
|
201
|
+
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
|
|
202
|
+
|
|
203
|
+
其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。<br/>
|
|
204
|
+
调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,代码示例:<br/>
|
|
205
|
+
HttpProfile httpProfile = new HttpProfile();<br/>
|
|
206
|
+
httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
207
|
+
*/
|
|
208
|
+
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
186
209
|
/**
|
|
187
210
|
* 查询出证报告,返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
|
|
188
211
|
*/
|
|
@@ -234,9 +257,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
234
257
|
*/
|
|
235
258
|
CreatePersonAuthCertificateImage(req: CreatePersonAuthCertificateImageRequest, cb?: (error: string, rep: CreatePersonAuthCertificateImageResponse) => void): Promise<CreatePersonAuthCertificateImageResponse>;
|
|
236
259
|
/**
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
*/
|
|
260
|
+
* 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将word、excel、图片文件转换为pdf文件。
|
|
261
|
+
*/
|
|
240
262
|
CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
|
|
241
263
|
/**
|
|
242
264
|
* 查询流程基础信息
|
|
@@ -249,15 +271,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
249
271
|
*/
|
|
250
272
|
CreateIntegrationUserRoles(req: CreateIntegrationUserRolesRequest, cb?: (error: string, rep: CreateIntegrationUserRolesResponse) => void): Promise<CreateIntegrationUserRolesResponse>;
|
|
251
273
|
/**
|
|
252
|
-
* 此接口(
|
|
253
|
-
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
|
|
274
|
+
* 此接口(ModifyIntegrationRole)用来更新企业自定义的SaaS角色或集团角色。
|
|
254
275
|
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
276
|
+
适用场景1:更新当前企业的自定义SaaS角色或集团角色,并且更新时不进行角色中权限的更新(PermissionGroups 参数不传)。
|
|
277
|
+
|
|
278
|
+
适用场景2:更新当前企业的自定义SaaS角色或集团角色,并且更新时进行角色中权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。
|
|
279
|
+
适用场景3:更新集团角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
280
|
+
|
|
281
|
+
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
282
|
+
|
|
283
|
+
注意事项:SaaS角色和集团角色对应的权限树是不一样的。
|
|
259
284
|
*/
|
|
260
|
-
|
|
285
|
+
ModifyIntegrationRole(req: ModifyIntegrationRoleRequest, cb?: (error: string, rep: ModifyIntegrationRoleResponse) => void): Promise<ModifyIntegrationRoleResponse>;
|
|
286
|
+
/**
|
|
287
|
+
* 对企业员工进行印章授权
|
|
288
|
+
*/
|
|
289
|
+
CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
|
|
261
290
|
/**
|
|
262
291
|
* 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
|
|
263
292
|
如果没有UserId,Name和Mobile必填,对应的员工必须在企业下已经实名,且该员工为批量签署合同中的签署方。
|
|
@@ -96,10 +96,19 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
96
96
|
return this.request("CreateUserAutoSignEnableUrl", req, cb);
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
99
|
+
* 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
|
|
100
|
+
|
|
101
|
+
适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
|
|
102
|
+
|
|
103
|
+
适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。
|
|
104
|
+
适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
105
|
+
|
|
106
|
+
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
107
|
+
|
|
108
|
+
注意事项:SaaS角色和集团角色对应的权限树是不一样的。
|
|
109
|
+
*/
|
|
110
|
+
async CreateIntegrationRole(req, cb) {
|
|
111
|
+
return this.request("CreateIntegrationRole", req, cb);
|
|
103
112
|
}
|
|
104
113
|
/**
|
|
105
114
|
* 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
|
|
@@ -108,7 +117,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
108
117
|
return this.request("CreateEmbedWebUrl", req, cb);
|
|
109
118
|
}
|
|
110
119
|
/**
|
|
111
|
-
*
|
|
120
|
+
* 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
|
|
112
121
|
*/
|
|
113
122
|
async VerifyPdf(req, cb) {
|
|
114
123
|
return this.request("VerifyPdf", req, cb);
|
|
@@ -209,6 +218,10 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
209
218
|
- 模板中配置的签署顺序是无序
|
|
210
219
|
- B端企业的签署方式是静默签署
|
|
211
220
|
- B端企业是非首位签署
|
|
221
|
+
|
|
222
|
+
通过一码多扫二维码发起的合同,涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)
|
|
223
|
+
|
|
224
|
+
用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
|
|
212
225
|
*/
|
|
213
226
|
async CreateMultiFlowSignQRCode(req, cb) {
|
|
214
227
|
return this.request("CreateMultiFlowSignQRCode", req, cb);
|
|
@@ -266,6 +279,18 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
266
279
|
async CreateChannelSubOrganizationModifyQrCode(req, cb) {
|
|
267
280
|
return this.request("CreateChannelSubOrganizationModifyQrCode", req, cb);
|
|
268
281
|
}
|
|
282
|
+
/**
|
|
283
|
+
* 此接口(UploadFiles)用于文件上传。<br/>
|
|
284
|
+
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
|
|
285
|
+
|
|
286
|
+
其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。<br/>
|
|
287
|
+
调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,代码示例:<br/>
|
|
288
|
+
HttpProfile httpProfile = new HttpProfile();<br/>
|
|
289
|
+
httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
290
|
+
*/
|
|
291
|
+
async UploadFiles(req, cb) {
|
|
292
|
+
return this.request("UploadFiles", req, cb);
|
|
293
|
+
}
|
|
269
294
|
/**
|
|
270
295
|
* 查询出证报告,返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
|
|
271
296
|
*/
|
|
@@ -337,9 +362,8 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
337
362
|
return this.request("CreatePersonAuthCertificateImage", req, cb);
|
|
338
363
|
}
|
|
339
364
|
/**
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
*/
|
|
365
|
+
* 上传了word、excel、图片文件后,通过该接口发起文件转换任务,将word、excel、图片文件转换为pdf文件。
|
|
366
|
+
*/
|
|
343
367
|
async CreateConvertTaskApi(req, cb) {
|
|
344
368
|
return this.request("CreateConvertTaskApi", req, cb);
|
|
345
369
|
}
|
|
@@ -358,16 +382,25 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
358
382
|
return this.request("CreateIntegrationUserRoles", req, cb);
|
|
359
383
|
}
|
|
360
384
|
/**
|
|
361
|
-
* 此接口(
|
|
362
|
-
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。<br/>
|
|
385
|
+
* 此接口(ModifyIntegrationRole)用来更新企业自定义的SaaS角色或集团角色。
|
|
363
386
|
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
387
|
+
适用场景1:更新当前企业的自定义SaaS角色或集团角色,并且更新时不进行角色中权限的更新(PermissionGroups 参数不传)。
|
|
388
|
+
|
|
389
|
+
适用场景2:更新当前企业的自定义SaaS角色或集团角色,并且更新时进行角色中权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。
|
|
390
|
+
适用场景3:更新集团角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。
|
|
391
|
+
|
|
392
|
+
适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。
|
|
393
|
+
|
|
394
|
+
注意事项:SaaS角色和集团角色对应的权限树是不一样的。
|
|
368
395
|
*/
|
|
369
|
-
async
|
|
370
|
-
return this.request("
|
|
396
|
+
async ModifyIntegrationRole(req, cb) {
|
|
397
|
+
return this.request("ModifyIntegrationRole", req, cb);
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* 对企业员工进行印章授权
|
|
401
|
+
*/
|
|
402
|
+
async CreateSealPolicy(req, cb) {
|
|
403
|
+
return this.request("CreateSealPolicy", req, cb);
|
|
371
404
|
}
|
|
372
405
|
/**
|
|
373
406
|
* 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
|