tencentcloud-sdk-nodejs-essbasic 4.0.711 → 4.0.713

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

@@ -19,7 +19,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse>;
     /**
-       * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
+       * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+  适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
+  常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
   
   **本接口适用于发起方没有填写控件的 B2C或者单C模板**
   
@@ -109,8 +111,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
     /**
-     * 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
-     */
+       * 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
+  该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
+  如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
+       */
     ChannelCancelMultiFlowSignQRCode(req: ChannelCancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCancelMultiFlowSignQRCodeResponse) => void): Promise<ChannelCancelMultiFlowSignQRCodeResponse>;
     /**
        * 查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
@@ -119,6 +123,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   3. 使用手机号验证签署方身份
   4. 骑缝章
   5. 拓宽签署方年龄限制
+  6. 下载企业合同/文件
   
   注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
        */
@@ -409,10 +414,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
     /**
-       * 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息
-  注意:
-  该接口不可直接调用，请联系客户经理申请使用
-  仅能催办当前状态为“待签署”的签署人，且只能催办一次
+       * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+  
+  1. 合同中当前状态为“待签署”的签署人是催办的对象
+  2. 每个合同只能催办一次
+  
+  注意：该接口无法直接调用，请联系客户经理申请使用。
        */
     ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
     /**
@@ -502,8 +509,66 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
     /**
-     * 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
-     */
+       * 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
+  
+  合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+  
+  适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+  
+  **注**:
+  <ul>
+  <li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+  <li>合同组暂不支持抄送功能</li>
+  </ul>
+  
+  **可以作为发起方和签署方的角色列表**
+  <table>
+  <thead>
+  <tr>
+  <th>场景编号</th>
+  <th>可作为发起方类型</th>
+  <th>可作为签署方的类型</th>
+  </tr>
+  </thead>
+  
+  <tbody>
+  <tr>
+  <td>场景一</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业A员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景二</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B(不指定经办人)</td>
+  </tr>
+  
+  <tr>
+  <td>场景三</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景四</td>
+  <td>第三方子企业A员工</td>
+  <td>个人/自然人</td>
+  </tr>
+  
+  <tr>
+  <td>场景五</td>
+  <td>第三方子企业A员工</td>
+  <td>SaaS平台企业员工</td>
+  </tr>
+  </tbody>
+  </table>
+  
+  **注**:
+  `1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+  
+  `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
+       */
     ChannelCreateFlowGroupByTemplates(req: ChannelCreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByTemplatesResponse) => void): Promise<ChannelCreateFlowGroupByTemplatesResponse>;
     /**
        * 此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接（需要在移动端打开，会跳转到微信小程序），支持创建企业超管变更链接或企业基础信息变更链接，通过入参 ChangeType 指定。
@@ -576,8 +641,67 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     ChannelCreatePreparedPersonalEsign(req: ChannelCreatePreparedPersonalEsignRequest, cb?: (error: string, rep: ChannelCreatePreparedPersonalEsignResponse) => void): Promise<ChannelCreatePreparedPersonalEsignResponse>;
     /**
-     * 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
-     */
+       * 接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
+  
+  合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+  
+  适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+  
+  
+  
+  **注**:
+  <ul>
+  <li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+  <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。</li>
+  </ul>
+  
+  **可以作为发起方和签署方的角色列表**
+  <table>
+  <thead>
+  <tr>
+  <th>场景编号</th>
+  <th>可作为发起方类型</th>
+  <th>可作为签署方的类型</th>
+  </tr>
+  </thead>
+  
+  <tbody>
+  <tr>
+  <td>场景一</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业A员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景二</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B(不指定经办人)</td>
+  </tr>
+  
+  <tr>
+  <td>场景三</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景四</td>
+  <td>第三方子企业A员工</td>
+  <td>个人/自然人</td>
+  </tr>
+  
+  <tr>
+  <td>场景五</td>
+  <td>第三方子企业A员工</td>
+  <td>SaaS平台企业员工</td>
+  </tr>
+  </tbody>
+  </table>
+  
+  **注**:
+  `1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+  `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
+       */
     ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
     /**
        * 本接口（ChannelCreateEmbedWebUrl）用于创建常规模块嵌入web的链接

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

@@ -44,7 +44,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreateFlowSignReview", req, cb);
     }
     /**
-       * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
+       * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+  适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
+  常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
   
   **本接口适用于发起方没有填写控件的 B2C或者单C模板**
   
@@ -142,8 +144,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateSealByImage", req, cb);
     }
     /**
-     * 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
-     */
+       * 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
+  该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
+  如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
+       */
     async ChannelCancelMultiFlowSignQRCode(req, cb) {
         return this.request("ChannelCancelMultiFlowSignQRCode", req, cb);
     }
@@ -154,6 +158,7 @@ class Client extends TencentCloudCommon.AbstractClient {
   3. 使用手机号验证签署方身份
   4. 骑缝章
   5. 拓宽签署方年龄限制
+  6. 下载企业合同/文件
   
   注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
        */
@@ -500,10 +505,12 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreateWebThemeConfig", req, cb);
     }
     /**
-       * 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息
-  注意:
-  该接口不可直接调用，请联系客户经理申请使用
-  仅能催办当前状态为“待签署”的签署人，且只能催办一次
+       * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+  
+  1. 合同中当前状态为“待签署”的签署人是催办的对象
+  2. 每个合同只能催办一次
+  
+  注意：该接口无法直接调用，请联系客户经理申请使用。
        */
     async ChannelCreateFlowReminds(req, cb) {
         return this.request("ChannelCreateFlowReminds", req, cb);
@@ -621,8 +628,66 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("SyncProxyOrganization", req, cb);
     }
     /**
-     * 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
-     */
+       * 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
+  
+  合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+  
+  适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+  
+  **注**:
+  <ul>
+  <li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+  <li>合同组暂不支持抄送功能</li>
+  </ul>
+  
+  **可以作为发起方和签署方的角色列表**
+  <table>
+  <thead>
+  <tr>
+  <th>场景编号</th>
+  <th>可作为发起方类型</th>
+  <th>可作为签署方的类型</th>
+  </tr>
+  </thead>
+  
+  <tbody>
+  <tr>
+  <td>场景一</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业A员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景二</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B(不指定经办人)</td>
+  </tr>
+  
+  <tr>
+  <td>场景三</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景四</td>
+  <td>第三方子企业A员工</td>
+  <td>个人/自然人</td>
+  </tr>
+  
+  <tr>
+  <td>场景五</td>
+  <td>第三方子企业A员工</td>
+  <td>SaaS平台企业员工</td>
+  </tr>
+  </tbody>
+  </table>
+  
+  **注**:
+  `1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+  
+  `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
+       */
     async ChannelCreateFlowGroupByTemplates(req, cb) {
         return this.request("ChannelCreateFlowGroupByTemplates", req, cb);
     }
@@ -707,8 +772,67 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChannelCreatePreparedPersonalEsign", req, cb);
     }
     /**
-     * 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
-     */
+       * 接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
+  
+  合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+  
+  适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+  
+  
+  
+  **注**:
+  <ul>
+  <li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+  <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。</li>
+  </ul>
+  
+  **可以作为发起方和签署方的角色列表**
+  <table>
+  <thead>
+  <tr>
+  <th>场景编号</th>
+  <th>可作为发起方类型</th>
+  <th>可作为签署方的类型</th>
+  </tr>
+  </thead>
+  
+  <tbody>
+  <tr>
+  <td>场景一</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业A员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景二</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B(不指定经办人)</td>
+  </tr>
+  
+  <tr>
+  <td>场景三</td>
+  <td>第三方子企业A员工</td>
+  <td>第三方子企业B员工</td>
+  </tr>
+  
+  <tr>
+  <td>场景四</td>
+  <td>第三方子企业A员工</td>
+  <td>个人/自然人</td>
+  </tr>
+  
+  <tr>
+  <td>场景五</td>
+  <td>第三方子企业A员工</td>
+  <td>SaaS平台企业员工</td>
+  </tr>
+  </tbody>
+  </table>
+  
+  **注**:
+  `1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+  `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
+       */
     async ChannelCreateFlowGroupByFiles(req, cb) {
         return this.request("ChannelCreateFlowGroupByFiles", req, cb);
     }