tencentcloud-sdk-nodejs-essbasic 4.0.720 → 4.0.722

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

@@ -462,11 +462,13 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
      * 撤销签署流程接口
 
 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
-<ul><li> `可撤回合同状态` ：未全部签署完成</li>
-<li> `不撤回合同状态` ：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。</li></ul>
+
+- **可撤回合同状态**：未全部签署完成
+- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
 注:
-<ul><li>能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人`  </li>
-<li>签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>。</li></ul>
+- 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+- 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
      */
   async ChannelCancelFlow(
     req: ChannelCancelFlowRequest,
@@ -620,17 +622,24 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   /**
      * 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
 
-> **适用场景** 
->
->  该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。 
->  一个模板通常会包含以下结构信息
->- 模板基本信息
->- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
->- 填写控件 Components
->- 签署控件 SignComponents
->- 生成模板的文件基础信息 FileInfos
+**一个模板通常会包含以下结构信息** 
+
+- 模板模版ID, 模板名字等基本信息
+- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
+- 发起方和签署方的填写控件 Components
+- 签署方的签署控件 SignComponents
+
+**适用场景**
+ 该接口常用来配合<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创建的链接登录子客控制台自己创建
 
-注意：
+
+**注意**
 
 >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。
 >2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准
@@ -736,15 +745,15 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows
-客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
-接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销;
+     * 通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同,   返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开,  跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
+
+适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
 
-可以撤回：未全部签署完成
- 不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+- **可撤回合同状态**：未全部签署完成
+- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
-注意:
-能撤回合同的只能是合同的发起人或者发起企业的超管、法人
+注:
+- 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
      */
   async ChannelCreateBatchCancelFlowUrl(
     req: ChannelCreateBatchCancelFlowUrlRequest,
@@ -898,8 +907,16 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。
-合同发起人必须在电子签已经进行实名。
+     * 发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
+解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。
+
+注意：
+<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
+<li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>
+<li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>
+<li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
+<li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>
+<li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li></ul>
      */
   async ChannelCreateReleaseFlow(
     req: ChannelCreateReleaseFlowRequest,
@@ -919,22 +936,16 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 用于批量撤销合同流程<br/>
-适用场景：
-如果某些合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
-通过签署流程编号批量撤销合同，单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是，若合同处于以下已终止状态，则不可撤销：<br/>
-- 已全部签署完成
-- 已拒签
-- 已过期
-- 已撤回
-- 拒绝填写
-- 已解除
-
-<br/>
-满足撤销条件的合同会发起异步撤销流程，而不满足撤销条件的合同将返回失败原因。合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
-<br/><br/>
+     * 通过合同编号批量撤销合同，单次最多支持撤销100份合同。
+
+适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
+
+- **可撤回合同状态**：未全部签署完成
+- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
 注:
-`如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，`签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+- 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+- 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
      */
   async ChannelBatchCancelFlows(
     req: ChannelBatchCancelFlowsRequest,
@@ -946,7 +957,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   /**
      * 该接口 (PrepareFlows) 用于创建待发起文件
 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-目前该接口只支持B2C，不建议使用，将会**废弃**。
+目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
      */
   async PrepareFlows(
     req: PrepareFlowsRequest,
@@ -1050,8 +1061,8 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
 
 注: 
-1. `图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下`
-2. `联调开发环境调用时需要设置Domain接口请求域名为 file.test.ess.tencent.cn，正式环境需要设置为file.ess.tencent.cn，代码示例`
+1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
+2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>,  联调开发环境为 **file.test.ess.tencent.cn**，正式环境需要设置为**file.ess.tencent.cn**，代码示例
 ```
 HttpProfile httpProfile = new HttpProfile();
 httpProfile.setEndpoint("file.test.ess.tencent.cn");
@@ -1204,7 +1215,17 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
 
   /**
      * 此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。 
-若经办人信息有误，或者需要修改，也可以先将之前的经办人做离职操作，然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
+
+- **新增员工的的场景**:    提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
+
+- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了,   同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空,  再次加入公司会从零开始) ,  若员工信息有误可通过离职后在新增来解决,  离职员工状态为**离职**
+
+![image](https://dyn.ess.tencent.cn/guide/capi/channel_SyncProxyOrganizationOperators.png)
+
+**注**:    
+-  新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
+-  <font color='red'>超管和法人无法通过此接口离职</font>,  需要超管和法人将权限转移给其他人后才可通过此接口离职
+- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
      */
   async SyncProxyOrganizationOperators(
     req: SyncProxyOrganizationOperatorsRequest,
@@ -1343,8 +1364,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
-   */
+     * 此接口用于查询合同或者合同组的详情信息，支持查询多个（数量不能超过100）。
+
+适用场景：可用于主动查询某个合同或者合同组的详情信息。
+
+注:  `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
+     */
   async DescribeFlowDetailInfo(
     req: DescribeFlowDetailInfoRequest,
     cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void
@@ -1353,8 +1378,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
-   */
+     * 获取个人用户自动签的开通链接。
+
+注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
+     */
   async ChannelCreateUserAutoSignEnableUrl(
     req: ChannelCreateUserAutoSignEnableUrlRequest,
     cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void