tencentcloud-sdk-nodejs-essbasic 4.0.720 → 4.0.721

package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts

@@ -187,11 +187,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        * 撤销签署流程接口
   
   适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
-  <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>
        */
     ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
     /**
@@ -297,17 +299,24 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 通过此接口（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为准
@@ -383,15 +392,15 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
     /**
-       * 指定需要批量撤销的签署流程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>
        */
     ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
     /**
@@ -473,8 +482,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
     /**
-       * 发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。
-  合同发起人必须在电子签已经进行实名。
+       * 发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
+  解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。
+  
+  注意：
+  <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
+  <li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>
+  <li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>
+  <li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
+  <li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>
+  <li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li></ul>
        */
     ChannelCreateReleaseFlow(req: ChannelCreateReleaseFlowRequest, cb?: (error: string, rep: ChannelCreateReleaseFlowResponse) => void): Promise<ChannelCreateReleaseFlowResponse>;
     /**
@@ -482,28 +499,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
     /**
-       * 用于批量撤销合同流程<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>
        */
     ChannelBatchCancelFlows(req: ChannelBatchCancelFlowsRequest, cb?: (error: string, rep: ChannelBatchCancelFlowsResponse) => void): Promise<ChannelBatchCancelFlowsResponse>;
     /**
        * 该接口 (PrepareFlows) 用于创建待发起文件
   用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-  目前该接口只支持B2C，不建议使用，将会**废弃**。
+  目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
        */
     PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
     /**
@@ -796,8 +807,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
     /**
-     * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
-     */
+       * 获取个人用户自动签的开通链接。
+  
+  注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
+       */
     ChannelCreateUserAutoSignEnableUrl(req: ChannelCreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void): Promise<ChannelCreateUserAutoSignEnableUrlResponse>;
     /**
      * 查询流程填写控件内容，可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意：使用此接口前，需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。

package/tencentcloud/services/essbasic/v20210526/essbasic_client.js

@@ -232,11 +232,13 @@ class Client extends TencentCloudCommon.AbstractClient {
        * 撤销签署流程接口
   
   适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
-  <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, cb) {
         return this.request("ChannelCancelFlow", req, cb);
@@ -358,17 +360,24 @@ class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 通过此接口（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为准
@@ -454,15 +463,15 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreatePrepareFlow", req, cb);
     }
     /**
-       * 指定需要批量撤销的签署流程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, cb) {
         return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
@@ -568,8 +577,16 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreateFlowSignUrl", req, cb);
     }
     /**
-       * 发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。
-  合同发起人必须在电子签已经进行实名。
+       * 发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
+  解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。
+  
+  注意：
+  <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, cb) {
         return this.request("ChannelCreateReleaseFlow", req, cb);
@@ -581,22 +598,16 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelDescribeEmployees", req, cb);
     }
     /**
-       * 用于批量撤销合同流程<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, cb) {
         return this.request("ChannelBatchCancelFlows", req, cb);
@@ -604,7 +615,7 @@ class Client extends TencentCloudCommon.AbstractClient {
     /**
        * 该接口 (PrepareFlows) 用于创建待发起文件
   用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-  目前该接口只支持B2C，不建议使用，将会**废弃**。
+  目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
        */
     async PrepareFlows(req, cb) {
         return this.request("PrepareFlows", req, cb);
@@ -935,8 +946,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("DescribeFlowDetailInfo", req, cb);
     }
     /**
-     * 企业方可以通过此接口获取个人用户开启自动签的跳转链接
-     */
+       * 获取个人用户自动签的开通链接。
+  
+  注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
+       */
     async ChannelCreateUserAutoSignEnableUrl(req, cb) {
         return this.request("ChannelCreateUserAutoSignEnableUrl", req, cb);
     }