tencentcloud-sdk-nodejs-essbasic 4.0.551 → 4.0.554
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 +516 -0
- package/SERVICE_CHANGELOG.md +467 -77
- package/package.json +1 -1
- package/products.md +35 -35
- package/src/services/essbasic/v20210526/essbasic_client.ts +29 -13
- package/src/services/essbasic/v20210526/essbasic_models.ts +317 -70
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +16 -12
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +17 -11
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +279 -70
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
|
|
2
|
-
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse,
|
|
2
|
+
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, UploadFilesRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, DescribeResourceUrlsByFlowsResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, SyncProxyOrganizationOperatorsResponse, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelCreateReleaseFlowRequest, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ModifyExtendedServiceResponse, ChannelGetTaskResultApiResponse, ChannelDeleteSealPoliciesResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, ChannelUpdateSealStatusRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse } from "./essbasic_models";
|
|
3
3
|
/**
|
|
4
4
|
* essbasic client
|
|
5
5
|
* @class
|
|
@@ -27,7 +27,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
27
27
|
*/
|
|
28
28
|
ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* 通过图片为子客企业代创建印章,图片最大5MB
|
|
31
31
|
*/
|
|
32
32
|
CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
|
|
33
33
|
/**
|
|
@@ -47,7 +47,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
47
47
|
*/
|
|
48
48
|
ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
|
|
49
49
|
/**
|
|
50
|
-
* 此接口(DescribeUsage
|
|
50
|
+
* 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
|
|
51
51
|
注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
52
52
|
*/
|
|
53
53
|
DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
|
|
@@ -58,7 +58,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
58
58
|
*/
|
|
59
59
|
ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* 将指定印章授权给第三方平台子客企业下的某些员工
|
|
62
62
|
*/
|
|
63
63
|
ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
|
|
64
64
|
/**
|
|
@@ -87,16 +87,20 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
87
87
|
*/
|
|
88
88
|
CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
|
|
89
89
|
/**
|
|
90
|
-
* 此接口(CreateConsoleLoginUrl
|
|
90
|
+
* 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。
|
|
91
91
|
若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
|
92
92
|
若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
|
93
93
|
若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
|
94
94
|
*/
|
|
95
95
|
CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
|
|
96
96
|
/**
|
|
97
|
-
* 此接口(ChannelCreateBoundFlows
|
|
97
|
+
* 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
|
|
98
98
|
*/
|
|
99
99
|
ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
|
|
100
|
+
/**
|
|
101
|
+
* 创建预发起合同
|
|
102
|
+
*/
|
|
103
|
+
ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
|
|
100
104
|
/**
|
|
101
105
|
* 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
|
|
102
106
|
客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
|
|
@@ -116,7 +120,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
116
120
|
*/
|
|
117
121
|
CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
|
|
118
122
|
/**
|
|
119
|
-
* 本接口(ChannelUpdateSealStatus
|
|
123
|
+
* 本接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态
|
|
120
124
|
*/
|
|
121
125
|
ChannelUpdateSealStatus(req: ChannelUpdateSealStatusRequest, cb?: (error: string, rep: ChannelUpdateSealStatusResponse) => void): Promise<ChannelUpdateSealStatusResponse>;
|
|
122
126
|
/**
|
|
@@ -166,7 +170,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
166
170
|
*/
|
|
167
171
|
DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
|
|
168
172
|
/**
|
|
169
|
-
* 通过此接口(DescribeTemplates
|
|
173
|
+
* 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
|
|
170
174
|
*/
|
|
171
175
|
DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
|
|
172
176
|
/**
|
|
@@ -184,11 +188,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
184
188
|
*/
|
|
185
189
|
ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
|
|
186
190
|
/**
|
|
187
|
-
* 此接口(SyncProxyOrganization
|
|
191
|
+
* 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
|
|
188
192
|
*/
|
|
189
193
|
SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
|
|
190
194
|
/**
|
|
191
|
-
* 此接口(SyncProxyOrganizationOperators
|
|
195
|
+
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
192
196
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
193
197
|
*/
|
|
194
198
|
SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
|
|
@@ -197,9 +201,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
197
201
|
*/
|
|
198
202
|
DescribeChannelFlowEvidenceReport(req: DescribeChannelFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeChannelFlowEvidenceReportResponse) => void): Promise<DescribeChannelFlowEvidenceReportResponse>;
|
|
199
203
|
/**
|
|
200
|
-
* 此接口(OperateChannelTemplate
|
|
204
|
+
* 此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置,不会直接分配第三方应用平台模板给子客企业。
|
|
201
205
|
1、OperateType=select时:
|
|
202
|
-
|
|
206
|
+
查询第三方应用平台模板库
|
|
203
207
|
2、OperateType=update或者delete时:
|
|
204
208
|
对子客企业进行模板库中模板可见性的修改、删除操作。
|
|
205
209
|
*/
|
|
@@ -56,7 +56,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
56
56
|
return this.request("ChannelCreateFlowByFiles", req, cb);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* 通过图片为子客企业代创建印章,图片最大5MB
|
|
60
60
|
*/
|
|
61
61
|
async CreateSealByImage(req, cb) {
|
|
62
62
|
return this.request("CreateSealByImage", req, cb);
|
|
@@ -86,7 +86,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
86
86
|
return this.request("ChannelCreateConvertTaskApi", req, cb);
|
|
87
87
|
}
|
|
88
88
|
/**
|
|
89
|
-
* 此接口(DescribeUsage
|
|
89
|
+
* 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
|
|
90
90
|
注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
91
91
|
*/
|
|
92
92
|
async DescribeUsage(req, cb) {
|
|
@@ -101,7 +101,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
101
101
|
return this.request("ChannelCancelFlow", req, cb);
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* 将指定印章授权给第三方平台子客企业下的某些员工
|
|
105
105
|
*/
|
|
106
106
|
async ChannelCreateSealPolicy(req, cb) {
|
|
107
107
|
return this.request("ChannelCreateSealPolicy", req, cb);
|
|
@@ -136,7 +136,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
136
136
|
return this.request("CreateSignUrls", req, cb);
|
|
137
137
|
}
|
|
138
138
|
/**
|
|
139
|
-
* 此接口(CreateConsoleLoginUrl
|
|
139
|
+
* 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。
|
|
140
140
|
若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
|
141
141
|
若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
|
142
142
|
若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
|
@@ -145,11 +145,17 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
145
145
|
return this.request("CreateConsoleLoginUrl", req, cb);
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
* 此接口(ChannelCreateBoundFlows
|
|
148
|
+
* 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
|
|
149
149
|
*/
|
|
150
150
|
async ChannelCreateBoundFlows(req, cb) {
|
|
151
151
|
return this.request("ChannelCreateBoundFlows", req, cb);
|
|
152
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* 创建预发起合同
|
|
155
|
+
*/
|
|
156
|
+
async ChannelCreatePrepareFlow(req, cb) {
|
|
157
|
+
return this.request("ChannelCreatePrepareFlow", req, cb);
|
|
158
|
+
}
|
|
153
159
|
/**
|
|
154
160
|
* 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
|
|
155
161
|
客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
|
|
@@ -175,7 +181,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
175
181
|
return this.request("CreateChannelFlowEvidenceReport", req, cb);
|
|
176
182
|
}
|
|
177
183
|
/**
|
|
178
|
-
* 本接口(ChannelUpdateSealStatus
|
|
184
|
+
* 本接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态
|
|
179
185
|
*/
|
|
180
186
|
async ChannelUpdateSealStatus(req, cb) {
|
|
181
187
|
return this.request("ChannelUpdateSealStatus", req, cb);
|
|
@@ -245,7 +251,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
245
251
|
return this.request("DescribeResourceUrlsByFlows", req, cb);
|
|
246
252
|
}
|
|
247
253
|
/**
|
|
248
|
-
* 通过此接口(DescribeTemplates
|
|
254
|
+
* 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
|
|
249
255
|
*/
|
|
250
256
|
async DescribeTemplates(req, cb) {
|
|
251
257
|
return this.request("DescribeTemplates", req, cb);
|
|
@@ -269,13 +275,13 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
269
275
|
return this.request("ChannelCreateFlowReminds", req, cb);
|
|
270
276
|
}
|
|
271
277
|
/**
|
|
272
|
-
* 此接口(SyncProxyOrganization
|
|
278
|
+
* 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
|
|
273
279
|
*/
|
|
274
280
|
async SyncProxyOrganization(req, cb) {
|
|
275
281
|
return this.request("SyncProxyOrganization", req, cb);
|
|
276
282
|
}
|
|
277
283
|
/**
|
|
278
|
-
* 此接口(SyncProxyOrganizationOperators
|
|
284
|
+
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
279
285
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
280
286
|
*/
|
|
281
287
|
async SyncProxyOrganizationOperators(req, cb) {
|
|
@@ -288,9 +294,9 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
288
294
|
return this.request("DescribeChannelFlowEvidenceReport", req, cb);
|
|
289
295
|
}
|
|
290
296
|
/**
|
|
291
|
-
* 此接口(OperateChannelTemplate
|
|
297
|
+
* 此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置,不会直接分配第三方应用平台模板给子客企业。
|
|
292
298
|
1、OperateType=select时:
|
|
293
|
-
|
|
299
|
+
查询第三方应用平台模板库
|
|
294
300
|
2、OperateType=update或者delete时:
|
|
295
301
|
对子客企业进行模板库中模板可见性的修改、删除操作。
|
|
296
302
|
*/
|