tencentcloud-sdk-nodejs-essbasic 4.0.721 → 4.0.723
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 +246 -0
- package/SERVICE_CHANGELOG.md +229 -110
- package/package.json +1 -1
- package/products.md +23 -23
- package/src/services/essbasic/v20210526/essbasic_client.ts +44 -16
- package/src/services/essbasic/v20210526/essbasic_models.ts +236 -155
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +44 -16
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +44 -16
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +236 -155
|
@@ -306,6 +306,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
306
306
|
- 发起方和签署方的填写控件 Components
|
|
307
307
|
- 签署方的签署控件 SignComponents
|
|
308
308
|
|
|
309
|
+
|
|
310
|
+
|
|
309
311
|
**适用场景**
|
|
310
312
|
该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口，作为创建合同的前置接口使用。
|
|
311
313
|
通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
|
|
@@ -422,12 +424,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
422
424
|
* 提交申请出证报告任务并返回报告ID。
|
|
423
425
|
|
|
424
426
|
注意：
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
427
|
+
- 使用此功能**需搭配出证套餐** ，使用前请联系对接的客户经理沟通。
|
|
428
|
+
- 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
|
|
429
|
+
- 合同流程必须**所有参与方已经签署完成**。
|
|
430
|
+
- 出证过程需一定时间，建议在**提交出证任务后的24小时之后**，通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
|
|
431
|
+
|
|
429
432
|
|
|
430
|
-
|
|
433
|
+
|
|
431
434
|
*/
|
|
432
435
|
CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
|
|
433
436
|
/**
|
|
@@ -475,10 +478,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
475
478
|
*/
|
|
476
479
|
ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
|
|
477
480
|
/**
|
|
478
|
-
*
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
481
|
+
* 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
|
|
482
|
+
|
|
483
|
+
`注意：`<br/>
|
|
484
|
+
`1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
|
|
485
|
+
`2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
|
|
486
|
+
`3. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建签署链接 。` <br/>
|
|
487
|
+
`4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。<br/>
|
|
488
|
+
跳转到小程序的实现，参考微信官方文档（分为<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>
|
|
482
489
|
*/
|
|
483
490
|
ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
|
|
484
491
|
/**
|
|
@@ -576,8 +583,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
576
583
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
577
584
|
|
|
578
585
|
注:
|
|
579
|
-
1.
|
|
580
|
-
2.
|
|
586
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
587
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**，正式环境需要设置为**file.ess.tencent.cn**，代码示例
|
|
581
588
|
```
|
|
582
589
|
HttpProfile httpProfile = new HttpProfile();
|
|
583
590
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
@@ -700,12 +707,29 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
700
707
|
CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
|
|
701
708
|
/**
|
|
702
709
|
* 此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。
|
|
703
|
-
|
|
710
|
+
|
|
711
|
+
- **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
712
|
+
|
|
713
|
+
- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
**注**:
|
|
718
|
+
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
719
|
+
- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
720
|
+
- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
704
721
|
*/
|
|
705
722
|
SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
|
|
706
723
|
/**
|
|
707
|
-
|
|
708
|
-
|
|
724
|
+
* 获取出证报告任务执行结果，返回报告 URL。
|
|
725
|
+
|
|
726
|
+
注意：
|
|
727
|
+
|
|
728
|
+
- 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
|
|
729
|
+
- 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
*/
|
|
709
733
|
DescribeChannelFlowEvidenceReport(req: DescribeChannelFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeChannelFlowEvidenceReportResponse) => void): Promise<DescribeChannelFlowEvidenceReportResponse>;
|
|
710
734
|
/**
|
|
711
735
|
* 此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。
|
|
@@ -803,8 +827,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
803
827
|
*/
|
|
804
828
|
ChannelCreateEmbedWebUrl(req: ChannelCreateEmbedWebUrlRequest, cb?: (error: string, rep: ChannelCreateEmbedWebUrlResponse) => void): Promise<ChannelCreateEmbedWebUrlResponse>;
|
|
805
829
|
/**
|
|
806
|
-
|
|
807
|
-
|
|
830
|
+
* 此接口用于查询合同或者合同组的详情信息，支持查询多个（数量不能超过100）。
|
|
831
|
+
|
|
832
|
+
适用场景：可用于主动查询某个合同或者合同组的详情信息。
|
|
833
|
+
|
|
834
|
+
注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
|
835
|
+
*/
|
|
808
836
|
DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
|
|
809
837
|
/**
|
|
810
838
|
* 获取个人用户自动签的开通链接。
|
|
@@ -367,6 +367,8 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
367
367
|
- 发起方和签署方的填写控件 Components
|
|
368
368
|
- 签署方的签署控件 SignComponents
|
|
369
369
|
|
|
370
|
+
|
|
371
|
+
|
|
370
372
|
**适用场景**
|
|
371
373
|
该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口，作为创建合同的前置接口使用。
|
|
372
374
|
通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
|
|
@@ -499,12 +501,13 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
499
501
|
* 提交申请出证报告任务并返回报告ID。
|
|
500
502
|
|
|
501
503
|
注意：
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
504
|
+
- 使用此功能**需搭配出证套餐** ，使用前请联系对接的客户经理沟通。
|
|
505
|
+
- 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
|
|
506
|
+
- 合同流程必须**所有参与方已经签署完成**。
|
|
507
|
+
- 出证过程需一定时间，建议在**提交出证任务后的24小时之后**，通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
|
|
508
|
+
|
|
506
509
|
|
|
507
|
-
|
|
510
|
+
|
|
508
511
|
*/
|
|
509
512
|
async CreateChannelFlowEvidenceReport(req, cb) {
|
|
510
513
|
return this.request("CreateChannelFlowEvidenceReport", req, cb);
|
|
@@ -568,10 +571,14 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
568
571
|
return this.request("ChannelCreateWebThemeConfig", req, cb);
|
|
569
572
|
}
|
|
570
573
|
/**
|
|
571
|
-
*
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
574
|
+
* 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
|
|
575
|
+
|
|
576
|
+
`注意：`<br/>
|
|
577
|
+
`1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
|
|
578
|
+
`2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
|
|
579
|
+
`3. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建签署链接 。` <br/>
|
|
580
|
+
`4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。<br/>
|
|
581
|
+
跳转到小程序的实现，参考微信官方文档（分为<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>
|
|
575
582
|
*/
|
|
576
583
|
async ChannelCreateFlowSignUrl(req, cb) {
|
|
577
584
|
return this.request("ChannelCreateFlowSignUrl", req, cb);
|
|
@@ -691,8 +698,8 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
691
698
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
692
699
|
|
|
693
700
|
注:
|
|
694
|
-
1.
|
|
695
|
-
2.
|
|
701
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
702
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**，正式环境需要设置为**file.ess.tencent.cn**，代码示例
|
|
696
703
|
```
|
|
697
704
|
HttpProfile httpProfile = new HttpProfile();
|
|
698
705
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
@@ -825,14 +832,31 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
825
832
|
}
|
|
826
833
|
/**
|
|
827
834
|
* 此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。
|
|
828
|
-
|
|
835
|
+
|
|
836
|
+
- **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
837
|
+
|
|
838
|
+
- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
**注**:
|
|
843
|
+
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
844
|
+
- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
845
|
+
- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
829
846
|
*/
|
|
830
847
|
async SyncProxyOrganizationOperators(req, cb) {
|
|
831
848
|
return this.request("SyncProxyOrganizationOperators", req, cb);
|
|
832
849
|
}
|
|
833
850
|
/**
|
|
834
|
-
|
|
835
|
-
|
|
851
|
+
* 获取出证报告任务执行结果，返回报告 URL。
|
|
852
|
+
|
|
853
|
+
注意：
|
|
854
|
+
|
|
855
|
+
- 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
|
|
856
|
+
- 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
*/
|
|
836
860
|
async DescribeChannelFlowEvidenceReport(req, cb) {
|
|
837
861
|
return this.request("DescribeChannelFlowEvidenceReport", req, cb);
|
|
838
862
|
}
|
|
@@ -940,8 +964,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
940
964
|
return this.request("ChannelCreateEmbedWebUrl", req, cb);
|
|
941
965
|
}
|
|
942
966
|
/**
|
|
943
|
-
|
|
944
|
-
|
|
967
|
+
* 此接口用于查询合同或者合同组的详情信息，支持查询多个（数量不能超过100）。
|
|
968
|
+
|
|
969
|
+
适用场景：可用于主动查询某个合同或者合同组的详情信息。
|
|
970
|
+
|
|
971
|
+
注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
|
972
|
+
*/
|
|
945
973
|
async DescribeFlowDetailInfo(req, cb) {
|
|
946
974
|
return this.request("DescribeFlowDetailInfo", req, cb);
|
|
947
975
|
}
|