tencentcloud-sdk-nodejs-ess 4.0.389 → 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 +6229 -0
- package/README.md +3 -3
- package/SERVICE_CHANGELOG.md +4213 -159
- package/package.json +1 -1
- package/products.md +99 -97
- package/src/services/ess/v20201111/ess_client.ts +87 -18
- package/src/services/ess/v20201111/ess_models.ts +406 -55
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +34 -8
- package/tencentcloud/services/ess/v20201111/ess_client.js +45 -9
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +358 -56
|
@@ -1,11 +1,16 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, DescribeFlowTemplatesResponse,
|
|
2
|
+
import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
|
|
3
3
|
/**
|
|
4
4
|
* ess client
|
|
5
5
|
* @class
|
|
6
6
|
*/
|
|
7
7
|
export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
8
8
|
constructor(clientConfig: TencentCloudCommon.ClientConfig);
|
|
9
|
+
/**
|
|
10
|
+
* 查询文件下载URL
|
|
11
|
+
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
12
|
+
*/
|
|
13
|
+
DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
|
|
9
14
|
/**
|
|
10
15
|
* 此接口用于发起流程
|
|
11
16
|
适用场景:见创建签署流程接口。
|
|
@@ -13,11 +18,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
13
18
|
*/
|
|
14
19
|
StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
|
|
15
20
|
/**
|
|
16
|
-
*
|
|
17
|
-
|
|
18
|
-
|
|
21
|
+
* 提交企业签署流程审批结果
|
|
22
|
+
适用场景:
|
|
23
|
+
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
24
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
25
|
+
|
|
19
26
|
*/
|
|
20
|
-
|
|
27
|
+
CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
|
|
21
28
|
/**
|
|
22
29
|
* 用于撤销签署流程
|
|
23
30
|
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
@@ -31,14 +38,19 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
31
38
|
*/
|
|
32
39
|
CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
|
|
33
40
|
/**
|
|
34
|
-
*
|
|
35
|
-
|
|
41
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
42
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
43
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
36
44
|
*/
|
|
37
|
-
|
|
45
|
+
CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
|
|
38
46
|
/**
|
|
39
47
|
* 通过AuthCode查询用户是否实名
|
|
40
48
|
*/
|
|
41
49
|
DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
|
|
50
|
+
/**
|
|
51
|
+
* 创建出证报告,返回报告 URL
|
|
52
|
+
*/
|
|
53
|
+
CreateFlowEvidenceReport(req: CreateFlowEvidenceReportRequest, cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void): Promise<CreateFlowEvidenceReportResponse>;
|
|
42
54
|
/**
|
|
43
55
|
* 创建签署流程
|
|
44
56
|
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
@@ -63,14 +75,28 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
63
75
|
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
64
76
|
*/
|
|
65
77
|
CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
|
|
78
|
+
/**
|
|
79
|
+
* 查询转换任务状态
|
|
80
|
+
*/
|
|
81
|
+
GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
|
|
82
|
+
/**
|
|
83
|
+
* 创建文件转换任务
|
|
84
|
+
*/
|
|
85
|
+
CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
|
|
66
86
|
/**
|
|
67
87
|
* 二期接口-查询模板
|
|
68
88
|
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
69
89
|
*/
|
|
70
90
|
DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
|
|
91
|
+
/**
|
|
92
|
+
* 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
|
93
|
+
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
94
|
+
*/
|
|
95
|
+
CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
|
|
71
96
|
/**
|
|
72
97
|
* 查询流程摘要
|
|
73
98
|
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
99
|
+
日调用量默认10W
|
|
74
100
|
*/
|
|
75
101
|
DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
|
|
76
102
|
/**
|
|
@@ -27,6 +27,13 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
27
27
|
constructor(clientConfig) {
|
|
28
28
|
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
|
|
29
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* 查询文件下载URL
|
|
32
|
+
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
33
|
+
*/
|
|
34
|
+
async DescribeFileUrls(req, cb) {
|
|
35
|
+
return this.request("DescribeFileUrls", req, cb);
|
|
36
|
+
}
|
|
30
37
|
/**
|
|
31
38
|
* 此接口用于发起流程
|
|
32
39
|
适用场景:见创建签署流程接口。
|
|
@@ -36,12 +43,14 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
36
43
|
return this.request("StartFlow", req, cb);
|
|
37
44
|
}
|
|
38
45
|
/**
|
|
39
|
-
*
|
|
40
|
-
|
|
41
|
-
|
|
46
|
+
* 提交企业签署流程审批结果
|
|
47
|
+
适用场景:
|
|
48
|
+
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
49
|
+
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
50
|
+
|
|
42
51
|
*/
|
|
43
|
-
async
|
|
44
|
-
return this.request("
|
|
52
|
+
async CreateFlowSignReview(req, cb) {
|
|
53
|
+
return this.request("CreateFlowSignReview", req, cb);
|
|
45
54
|
}
|
|
46
55
|
/**
|
|
47
56
|
* 用于撤销签署流程
|
|
@@ -60,11 +69,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
60
69
|
return this.request("CreateDocument", req, cb);
|
|
61
70
|
}
|
|
62
71
|
/**
|
|
63
|
-
*
|
|
64
|
-
|
|
72
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
73
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
74
|
+
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
65
75
|
*/
|
|
66
|
-
async
|
|
67
|
-
return this.request("
|
|
76
|
+
async CreateMultiFlowSignQRCode(req, cb) {
|
|
77
|
+
return this.request("CreateMultiFlowSignQRCode", req, cb);
|
|
68
78
|
}
|
|
69
79
|
/**
|
|
70
80
|
* 通过AuthCode查询用户是否实名
|
|
@@ -72,6 +82,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
72
82
|
async DescribeThirdPartyAuthCode(req, cb) {
|
|
73
83
|
return this.request("DescribeThirdPartyAuthCode", req, cb);
|
|
74
84
|
}
|
|
85
|
+
/**
|
|
86
|
+
* 创建出证报告,返回报告 URL
|
|
87
|
+
*/
|
|
88
|
+
async CreateFlowEvidenceReport(req, cb) {
|
|
89
|
+
return this.request("CreateFlowEvidenceReport", req, cb);
|
|
90
|
+
}
|
|
75
91
|
/**
|
|
76
92
|
* 创建签署流程
|
|
77
93
|
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
@@ -102,6 +118,18 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
102
118
|
async CreateSchemeUrl(req, cb) {
|
|
103
119
|
return this.request("CreateSchemeUrl", req, cb);
|
|
104
120
|
}
|
|
121
|
+
/**
|
|
122
|
+
* 查询转换任务状态
|
|
123
|
+
*/
|
|
124
|
+
async GetTaskResultApi(req, cb) {
|
|
125
|
+
return this.request("GetTaskResultApi", req, cb);
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* 创建文件转换任务
|
|
129
|
+
*/
|
|
130
|
+
async CreateConvertTaskApi(req, cb) {
|
|
131
|
+
return this.request("CreateConvertTaskApi", req, cb);
|
|
132
|
+
}
|
|
105
133
|
/**
|
|
106
134
|
* 二期接口-查询模板
|
|
107
135
|
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
@@ -109,9 +137,17 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
109
137
|
async DescribeFlowTemplates(req, cb) {
|
|
110
138
|
return this.request("DescribeFlowTemplates", req, cb);
|
|
111
139
|
}
|
|
140
|
+
/**
|
|
141
|
+
* 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
|
142
|
+
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
143
|
+
*/
|
|
144
|
+
async CreateBatchCancelFlowUrl(req, cb) {
|
|
145
|
+
return this.request("CreateBatchCancelFlowUrl", req, cb);
|
|
146
|
+
}
|
|
112
147
|
/**
|
|
113
148
|
* 查询流程摘要
|
|
114
149
|
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
150
|
+
日调用量默认10W
|
|
115
151
|
*/
|
|
116
152
|
async DescribeFlowBriefs(req, cb) {
|
|
117
153
|
return this.request("DescribeFlowBriefs", req, cb);
|