tencentcloud-sdk-nodejs 4.0.723 → 4.0.725

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

@@ -19,6 +19,7 @@ import { AbstractClient } from "../../../common/abstract_client"
 import { ClientConfig } from "../../../common/interface"
 import {
   SyncProxyOrganizationResponse,
+  BillUsageDetail,
   ChannelCreateConvertTaskApiResponse,
   ChannelCreateFlowRemindsResponse,
   Component,
@@ -83,6 +84,7 @@ import {
   CreateChannelFlowEvidenceReportRequest,
   ChannelCancelUserAutoSignEnableUrlRequest,
   Permission,
+  DescribeTemplatesRequest,
   Staff,
   ComponentLimit,
   ChannelVerifyPdfResponse,
@@ -115,6 +117,7 @@ import {
   ChannelDeleteRoleUsersResponse,
   SyncProxyOrganizationOperatorsRequest,
   ChannelCreateFlowApproversResponse,
+  DescribeBillUsageDetailResponse,
   CreateSignUrlsRequest,
   ChannelCreateMultiFlowSignQRCodeRequest,
   SignQrCode,
@@ -173,7 +176,7 @@ import {
   ChannelCreateFlowGroupByTemplatesRequest,
   SignUrl,
   ChannelCancelFlowRequest,
-  DescribeTemplatesRequest,
+  DescribeBillUsageDetailRequest,
   RelieveInfo,
   ChannelCreateSealPolicyRequest,
   OccupiedSeal,
@@ -479,12 +482,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-     * 通过此接口，创建小程序批量签署链接，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
+     * 通过此接口，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
 
 注：
 - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方或者领取方。
 - 仅支持传入待签署或者待领取的合同，待填写暂不支持。
-- 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章，暂不支持签批控件
+- 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
      */
   async ChannelCreateOrganizationBatchSignUrl(
     req: ChannelCreateOrganizationBatchSignUrlRequest,
@@ -623,6 +626,15 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   /**
      * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
 
+**适用场景**
+ 该接口常用来配合<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>接口，作为创建合同的前置接口使用。 
+通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
+
+**模版的来源**
+子客企业的模板有两种途径获取
+- 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
+- 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
+
 **一个模板通常会包含以下结构信息** 
 
 - 模板模版ID, 模板名字等基本信息
@@ -632,14 +644,8 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 
 ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
 
-**适用场景**
- 该接口常用来配合<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>接口，作为创建合同的前置接口使用。 
-通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
-
-**模版的来源**
-子客企业的模板有两种途径获取
-- 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
-- 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
+模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
 
 
 **注意**
@@ -715,6 +721,9 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 
 1. 若在激活过程中，**更换用户OpenID重新生成链接，之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作，会导致认证过程互相影响。
 2. 若您认证中发现信息有误需要重新认证，**可通过更换用户OpenID重新生成链接的方式，来清理掉已有的流程**。
+
+系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
+![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
      */
   async CreateConsoleLoginUrl(
     req: CreateConsoleLoginUrlRequest,
@@ -934,8 +943,10 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-   * 用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
-   */
+     * 获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息，支持设置过滤条件以筛选员工查询结果。
+
+**注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
+     */
   async ChannelDescribeEmployees(
     req: ChannelDescribeEmployeesRequest,
     cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void
@@ -1029,10 +1040,10 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 **第一种**:   需第三方应用的子企业登录控制台进行授权,  授权在**企业中心**的**授权管理**区域,  界面如下图
 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
 
-![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows2.png)
+![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
 
 **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
-![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeResourceUrlsByFlows_appilications2.png)
+![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
      */
   async DescribeResourceUrlsByFlows(
     req: DescribeResourceUrlsByFlowsRequest,
@@ -1084,12 +1095,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-     * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+     * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办
+1. 合同中当前状态为 **待签署** 的签署人是催办的对象
+2. **每个合同只能催办一次**
+
+**催办的效果**: 对方会受到如下的短信通知
+![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
 
-1. 合同中当前状态为“待签署”的签署人是催办的对象
-2. 每个合同只能催办一次
 
-注意：该接口无法直接调用，请联系客户经理申请使用。
+**注**：`合同催办是白名单功能，请联系客户经理申请开白后使用`
      */
   async ChannelCreateFlowReminds(
     req: ChannelCreateFlowRemindsRequest,
@@ -1099,9 +1113,20 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-     * 此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称，企业营业执照，企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意：
-1. 需要在子客企业激活前调用该接口，如果您的企业已经提交企业信息或者企业已经激活，同步的企业信息将不会生效。
-2. 如果您同时传递了营业执照信息和企业名称等信息，在认证过程中将以营业执照中的企业信息为准，请注意企业信息需要和营业执照信息对应。
+     * 此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
+
+注意：
+
+- **需要在<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形
+- **企业信息需要和营业执照信息对应**,  否则会出现激活过程验证不通过的问题
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/7ec91b79a0a4860e77c9ff9f4a5f13ad/channel_SyncProxyOrganization2.png)
+
+
+- **企业统一社会信用代码**: 对应上图中的**1**
+- **第三方平台子客企业名称**: 对应上图中的**2**
+- **企业法定代表人的名字**:对应上图中的**3**
+- **企业详细住所**:对应上图中的**4**
      */
   async SyncProxyOrganization(
     req: SyncProxyOrganizationRequest,
@@ -1224,7 +1249,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   /**
      * 此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。 
 
-- **新增员工的的场景**:    提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
+- **新增员工的场景**:    提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
 
 - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了,   同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空,  再次加入公司会从零开始) ,  若员工信息有误可通过离职后在新增来解决,  离职员工状态为**离职**
 
@@ -1233,7 +1258,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
 **注**:    
 -  新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
 -  <font color='red'>超管和法人无法通过此接口离职</font>,  需要超管和法人将权限转移给其他人后才可通过此接口离职
-- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
+- 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
      */
   async SyncProxyOrganizationOperators(
     req: SyncProxyOrganizationOperatorsRequest,
@@ -1295,6 +1320,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     return this.request("ChannelCreatePreparedPersonalEsign", req, cb)
   }
 
+  /**
+   * 通过此接口（DescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
+   */
+  async DescribeBillUsageDetail(
+    req: DescribeBillUsageDetailRequest,
+    cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void
+  ): Promise<DescribeBillUsageDetailResponse> {
+    return this.request("DescribeBillUsageDetail", req, cb)
+  }
+
   /**
      * 接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。