tencentcloud-sdk-nodejs 4.0.727 → 4.0.729

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -72,6 +72,7 @@ import {
   RecipientComponentInfo,
   ChannelDescribeRolesRequest,
   PrepareFlowsResponse,
+  ChannelCancelFlowRequest,
   TemplateInfo,
   ChannelCreateOrganizationBatchSignUrlRequest,
   GetDownloadFlowUrlResponse,
@@ -82,6 +83,7 @@ import {
   StaffRole,
   ChannelVerifyPdfRequest,
   CreateChannelFlowEvidenceReportRequest,
+  ChannelDescribeBillUsageDetailRequest,
   ChannelCancelUserAutoSignEnableUrlRequest,
   Permission,
   DescribeTemplatesRequest,
@@ -124,8 +126,9 @@ import {
   FlowApproverInfo,
   ChannelCreateUserAutoSignEnableUrlResponse,
   ChannelGetTaskResultApiRequest,
-  FillError,
   ChannelCreatePreparedPersonalEsignRequest,
+  FillError,
+  ChannelDescribeBillUsageDetailResponse,
   FlowDetailInfo,
   CreateFlowsByTemplatesResponse,
   DescribeChannelFlowEvidenceReportRequest,
@@ -158,6 +161,7 @@ import {
   ChannelCreateFlowGroupByFilesResponse,
   ChannelCreateMultiFlowSignQRCodeResponse,
   ApproverOption,
+  ChannelDescribeUserAutoSignStatusResponse,
   ProxyOrganizationOperator,
   ModifyExtendedServiceResponse,
   ChannelCreateUserRolesRequest,
@@ -175,7 +179,7 @@ import {
   ChannelUpdateSealStatusRequest,
   ChannelCreateFlowGroupByTemplatesRequest,
   SignUrl,
-  ChannelCancelFlowRequest,
+  ChannelBillUsageDetail,
   DescribeBillUsageDetailRequest,
   RelieveInfo,
   ChannelCreateSealPolicyRequest,
@@ -190,12 +194,11 @@ import {
   CreateChannelFlowEvidenceReportResponse,
   SyncFailReason,
   ChannelDescribeEmployeesResponse,
-  ChannelCreateFlowApproversRequest,
   ChannelDeleteRoleResponse,
   ChannelCreateReleaseFlowResponse,
   DescribeChannelFlowEvidenceReportResponse,
   CreateSealByImageRequest,
-  ChannelDescribeUserAutoSignStatusResponse,
+  ChannelCreateFlowApproversRequest,
   ChannelUpdateSealStatusResponse,
   ChannelCreateFlowSignUrlRequest,
   DescribeExtendedServiceAuthInfoResponse,
@@ -275,21 +278,21 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 
   /**
      * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 
-适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
-常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
-
-**本接口适用于发起方没有填写控件的 B2C或者单C模板**
 
-**若是B2C模板,还要满足以下任意一个条件**
+**适用场景**:
+签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
-- 模板中配置的签署顺序是无序
-- B端企业的签署方式是静默签署
-- B端企业是非首位签署
-
-通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+**注意**:
+1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**,  若是B2C模板,还要满足以下任意一个条件
+    - 模板中配置的签署顺序是无序
+    - B端企业的签署方式是静默签署
+    - B端企业是非首位签署
+2. 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
 ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
+3. 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/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)
 
-用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/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)
+二维码的样式如下图:
+![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
      */
   async ChannelCreateMultiFlowSignQRCode(
     req: ChannelCreateMultiFlowSignQRCodeRequest,
@@ -303,7 +306,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 
 适用场景1：更新当前企业的自定义角色的名称或描述等其他信息，更新时不进行权限的设置（PermissionGroups 参数不传）。
 
-适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
+适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
      */
   async ChannelModifyRole(
     req: ChannelModifyRoleRequest,
@@ -452,8 +455,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-     * 此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。
- 注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
+     * 此接口（DescribeUsage）用于获取此应用下子客企业的合同消耗数量。
+
+注: 此接口**每日限频50次**，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
      */
   async DescribeUsage(
     req: DescribeUsageRequest,
@@ -507,14 +511,15 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-     * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
-`注意：`<br/>
-`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
-`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
-`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。` <br/>
-`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。` <br/>
-`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`<br/>
-跳转到小程序的实现，参考微信官方文档(分为<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>
+     * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。
+**注意**：
+1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。
+2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**，**不支持填写控件** 。
+3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。
+4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
+5. 该接口返回的签署链接适用于APP集成的场景，支持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>。
+6.  因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
      */
   async ChannelCreateBatchQuickSignUrl(
     req: ChannelCreateBatchQuickSignUrlRequest,
@@ -645,6 +650,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
 
 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+
 ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
 
 
@@ -847,8 +853,26 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-   * 此接口（ChannelCreateBoundFlows）用于子客领取合同，经办人需要有相应的角色，合同不能重复领取。
-   */
+     * 此接口（ChannelCreateBoundFlows）用于子客企业领取未归属给员工的合同，将合同领取给当前员工，合同不能重复领取。
+
+
+**未归属合同发起方式**
+ 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等),  则合同进入待领取状态, 示例代码如下
+```
+		FlowApprovers: []*essbasic.FlowApproverInfo{
+			{
+				ApproverType:       common.StringPtr("ORGANIZATION"),
+				OrganizationOpenId: common.StringPtr("org_dianziqian"),
+				OrganizationName:   common.StringPtr("典子谦示例企业"),
+			}
+		},
+```
+
+可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
+![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
+
+注: `支持批量领取,  如果有一个合同流程无法领取会导致接口报错,  使得所有合同都领取失败`
+     */
   async ChannelCreateBoundFlows(
     req: ChannelCreateBoundFlowsRequest,
     cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void
@@ -907,14 +931,15 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
-
-`注意：`<br/>
-`1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
-`2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
-`3. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建签署链接 。` <br/>
-`4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。<br/>
-跳转到小程序的实现，参考微信官方文档（分为<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>
+     * 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
+
+**注意**
+1. 该接口目前**仅支持签署人类型是个人签署方**的场景（PERSON）。
+2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，**不支持填写控件** 。
+3. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
+4. 该接口返回的签署链接适用于APP集成的场景，支持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>。
+5. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
      */
   async ChannelCreateFlowSignUrl(
     req: ChannelCreateFlowSignUrlRequest,
@@ -991,8 +1016,8 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 
 注:
 <ul>
-<li>仅支持下载 **本企业** 下合同，链接会 **登录企业控制台** </li>
-<li> **链接仅可使用一次**，不可重复使用</li>
+<li>仅支持下载 <b>本企业</b> 下合同，链接会 <b>登录企业控制台</b> </li>
+<li> <b>链接仅可使用一次</b>，不可重复使用</li>
 </ul>
      */
   async GetDownloadFlowUrl(
@@ -1022,7 +1047,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 
 适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
 
-适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
+适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
      */
   async ChannelCreateRole(
     req: ChannelCreateRoleRequest,
@@ -1081,7 +1106,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 
 注: 
 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
-2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>,  联调开发环境为 **file.test.ess.tencent.cn**，正式环境需要设置为**file.ess.tencent.cn**，代码示例
+2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>,  联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>，正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>，代码示例
 ```
 HttpProfile httpProfile = new HttpProfile();
 httpProfile.setEndpoint("file.test.ess.tencent.cn");
@@ -1099,7 +1124,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
 1. 合同中当前状态为 **待签署** 的签署人是催办的对象
 2. **每个合同只能催办一次**
 
-**催办的效果**: 对方会受到如下的短信通知
+**催办的效果**: 对方会收到如下的短信通知
+
 ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
 
 
@@ -1321,8 +1347,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 通过此接口（DescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
-   */
+     * 废弃接口
+
+通过此接口（DescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
+     */
   async DescribeBillUsageDetail(
     req: DescribeBillUsageDetailRequest,
     cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void
@@ -1427,6 +1455,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     return this.request("DescribeFlowDetailInfo", req, cb)
   }
 
+  /**
+   * 通过此接口（ChannelDescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
+   */
+  async ChannelDescribeBillUsageDetail(
+    req: ChannelDescribeBillUsageDetailRequest,
+    cb?: (error: string, rep: ChannelDescribeBillUsageDetailResponse) => void
+  ): Promise<ChannelDescribeBillUsageDetailResponse> {
+    return this.request("ChannelDescribeBillUsageDetail", req, cb)
+  }
+
   /**
      * 获取个人用户自动签的开通链接。
 
@@ -1440,8 +1478,22 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
-   */
+     * 用于获取合同中填写控件填写状态和填写的内容。 
+
+**注意**: `附件控件不会出现在结果列表中`
+
+
+**授权**:   
+此接口需要授权,  有两种开通权限的途径
+
+**第一种**:   需第三方应用的子企业登录控制台进行授权,  授权在**企业中心**的**授权管理**区域,  界面如下图
+授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
+
+**第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
+![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
+     */
   async ChannelDescribeFlowComponents(
     req: ChannelDescribeFlowComponentsRequest,
     cb?: (error: string, rep: ChannelDescribeFlowComponentsResponse) => void