tencentcloud-sdk-nodejs-essbasic 4.0.758 → 4.0.760

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.
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeTemplatesRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
2
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeExtendedServiceAuthDetailRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeTemplatesRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
3
  /**
4
4
  * essbasic client
5
5
  * @class
@@ -136,6 +136,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
136
136
  `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
137
137
  */
138
138
  ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
139
+ /**
140
+ * 此接口用于获取企业批量认证异步任务的状态及结果。
141
+
142
+ 前提条件:已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口,并得到了任务Id。
143
+
144
+ 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间
145
+ */
146
+ DescribeBatchOrganizationRegistrationUrls(req: DescribeBatchOrganizationRegistrationUrlsRequest, cb?: (error: string, rep: DescribeBatchOrganizationRegistrationUrlsResponse) => void): Promise<DescribeBatchOrganizationRegistrationUrlsResponse>;
139
147
  /**
140
148
  * 1. 可以**通过图片**为子客企业代创建印章,图片最大5MB
141
149
 
@@ -193,6 +201,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
193
201
  注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
194
202
  */
195
203
  DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
204
+ /**
205
+ * 查询企业扩展服务的授权详情(列表),当前支持查询以下内容:
206
+
207
+ 1. **企业自动签**
208
+ 2. **批量签署**
209
+
210
+
211
+ 注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
212
+ */
213
+ DescribeExtendedServiceAuthDetail(req: DescribeExtendedServiceAuthDetailRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthDetailResponse) => void): Promise<DescribeExtendedServiceAuthDetailResponse>;
196
214
  /**
197
215
  * 撤销签署流程接口
198
216
 
@@ -342,6 +360,26 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
342
360
  >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
343
361
  */
344
362
  DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
363
+ /**
364
+ * 本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接
365
+ 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
366
+
367
+ 批量创建链接有以下限制:
368
+ 1. 单次最多创建10个子客。
369
+ 2. 一天同一家企业最多创建8000个子客。
370
+ 3. 同一批创建的子客不能重复 其中包括 企业名称,企业统一信用代码,子客经办人openId。
371
+ 4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置
372
+
373
+ 注: 1. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
374
+
375
+ **腾讯电子签小程序的AppID 和 原始Id如下:**
376
+
377
+ | 小程序 | AppID | 原始ID |
378
+ | ------------ | ------------ | ------------ |
379
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
380
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
381
+ */
382
+ CreateBatchOrganizationRegistrationTasks(req: CreateBatchOrganizationRegistrationTasksRequest, cb?: (error: string, rep: CreateBatchOrganizationRegistrationTasksResponse) => void): Promise<CreateBatchOrganizationRegistrationTasksResponse>;
345
383
  /**
346
384
  * 此接口(UploadFiles)文件上传。<br/>
347
385
 
@@ -604,6 +642,17 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
604
642
  2. 个人签署人仅支持通过姓名+手机号进行补充。
605
643
  */
606
644
  ChannelCreateFlowApprovers(req: ChannelCreateFlowApproversRequest, cb?: (error: string, rep: ChannelCreateFlowApproversResponse) => void): Promise<ChannelCreateFlowApproversResponse>;
645
+ /**
646
+ * 创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。
647
+ 该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
648
+
649
+
650
+
651
+ 注:
652
+ 1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
653
+ 2. 已经在授权中或者授权成功的企业,无法重复授权
654
+ */
655
+ CreatePartnerAutoSignAuthUrl(req: CreatePartnerAutoSignAuthUrlRequest, cb?: (error: string, rep: CreatePartnerAutoSignAuthUrlResponse) => void): Promise<CreatePartnerAutoSignAuthUrlResponse>;
607
656
  /**
608
657
  * 此接口(ChannelCreateRole)用来创建企业自定义角色。
609
658
 
@@ -169,6 +169,16 @@ class Client extends TencentCloudCommon.AbstractClient {
169
169
  async ChannelCreateFlowByFiles(req, cb) {
170
170
  return this.request("ChannelCreateFlowByFiles", req, cb);
171
171
  }
172
+ /**
173
+ * 此接口用于获取企业批量认证异步任务的状态及结果。
174
+
175
+ 前提条件:已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口,并得到了任务Id。
176
+
177
+ 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间
178
+ */
179
+ async DescribeBatchOrganizationRegistrationUrls(req, cb) {
180
+ return this.request("DescribeBatchOrganizationRegistrationUrls", req, cb);
181
+ }
172
182
  /**
173
183
  * 1. 可以**通过图片**为子客企业代创建印章,图片最大5MB
174
184
 
@@ -238,6 +248,18 @@ class Client extends TencentCloudCommon.AbstractClient {
238
248
  async DescribeUsage(req, cb) {
239
249
  return this.request("DescribeUsage", req, cb);
240
250
  }
251
+ /**
252
+ * 查询企业扩展服务的授权详情(列表),当前支持查询以下内容:
253
+
254
+ 1. **企业自动签**
255
+ 2. **批量签署**
256
+
257
+
258
+ 注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
259
+ */
260
+ async DescribeExtendedServiceAuthDetail(req, cb) {
261
+ return this.request("DescribeExtendedServiceAuthDetail", req, cb);
262
+ }
241
263
  /**
242
264
  * 撤销签署流程接口
243
265
 
@@ -405,6 +427,28 @@ class Client extends TencentCloudCommon.AbstractClient {
405
427
  async DescribeTemplates(req, cb) {
406
428
  return this.request("DescribeTemplates", req, cb);
407
429
  }
430
+ /**
431
+ * 本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接
432
+ 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
433
+
434
+ 批量创建链接有以下限制:
435
+ 1. 单次最多创建10个子客。
436
+ 2. 一天同一家企业最多创建8000个子客。
437
+ 3. 同一批创建的子客不能重复 其中包括 企业名称,企业统一信用代码,子客经办人openId。
438
+ 4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置
439
+
440
+ 注: 1. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
441
+
442
+ **腾讯电子签小程序的AppID 和 原始Id如下:**
443
+
444
+ | 小程序 | AppID | 原始ID |
445
+ | ------------ | ------------ | ------------ |
446
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
447
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
448
+ */
449
+ async CreateBatchOrganizationRegistrationTasks(req, cb) {
450
+ return this.request("CreateBatchOrganizationRegistrationTasks", req, cb);
451
+ }
408
452
  /**
409
453
  * 此接口(UploadFiles)文件上传。<br/>
410
454
 
@@ -713,6 +757,19 @@ class Client extends TencentCloudCommon.AbstractClient {
713
757
  async ChannelCreateFlowApprovers(req, cb) {
714
758
  return this.request("ChannelCreateFlowApprovers", req, cb);
715
759
  }
760
+ /**
761
+ * 创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。
762
+ 该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
763
+
764
+
765
+
766
+ 注:
767
+ 1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
768
+ 2. 已经在授权中或者授权成功的企业,无法重复授权
769
+ */
770
+ async CreatePartnerAutoSignAuthUrl(req, cb) {
771
+ return this.request("CreatePartnerAutoSignAuthUrl", req, cb);
772
+ }
716
773
  /**
717
774
  * 此接口(ChannelCreateRole)用来创建企业自定义角色。
718
775