tencentcloud-sdk-nodejs 4.0.712 → 4.0.714

package/src/services/ess/v20201111/ess_client.ts

@@ -27,8 +27,10 @@ import {
   Department,
   CreatePreparedPersonalEsignRequest,
   DescribeIntegrationDepartmentsResponse,
+  DeleteExtendedServiceAuthInfosResponse,
   CreateFlowApproversResponse,
   DescribeFileUrlsResponse,
+  CreateExtendedServiceAuthInfosRequest,
   ModifyApplicationCallbackInfoResponse,
   CreateMultiFlowSignQRCodeResponse,
   FlowApproverUrlInfo,
@@ -158,6 +160,7 @@ import {
   FileInfo,
   CancelUserAutoSignEnableUrlRequest,
   FailedCreateStaffData,
+  CreateExtendedServiceAuthInfosResponse,
   ApproverRestriction,
   CreateWebThemeConfigRequest,
   ApproverItem,
@@ -202,6 +205,7 @@ import {
   CreateBatchCancelFlowUrlRequest,
   CreateMultiFlowSignQRCodeRequest,
   DescribeFlowInfoRequest,
+  DeleteExtendedServiceAuthInfosRequest,
   DescribeIntegrationDepartmentsRequest,
   DescribeFlowInfoResponse,
   CancelMultiFlowSignQRCodeResponse,
@@ -720,8 +724,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。
-   */
+     * 本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。
+
+1. 可以**通过图片**创建印章，图片最大5MB
+2. 可以**系统创建**创建印章, 系统创建的印章样子下图(样式可以调整)
+
+![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage.png)
+     */
   async CreateSeal(
     req: CreateSealRequest,
     cb?: (error: string, rep: CreateSealResponse) => void
@@ -766,6 +775,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     return this.request("GetTaskResultApi", req, cb)
   }
 
+  /**
+     * 创建企业扩展服务授权，当前仅支持授权 “企业自动签” 给企业员工。
+
+注：支持集团代子企业操作，请联系运营开通此功能。
+     */
+  async CreateExtendedServiceAuthInfos(
+    req: CreateExtendedServiceAuthInfosRequest,
+    cb?: (error: string, rep: CreateExtendedServiceAuthInfosResponse) => void
+  ): Promise<CreateExtendedServiceAuthInfosResponse> {
+    return this.request("CreateExtendedServiceAuthInfos", req, cb)
+  }
+
   /**
      * 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
 该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
@@ -826,13 +847,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-     * 此接口（CreateConvertTaskApi）用来将word、excel、图片、txt类型文件转换为PDF文件。<br />
+     * 此接口（CreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
 前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
 注: 
-1. `支持的文件类型有doc、docx、xls、xlsx、jpg、jpeg、png、bmp、txt`
+1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
      */
   async CreateConvertTaskApi(
@@ -1122,6 +1143,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     return this.request("CreateSealPolicy", req, cb)
   }
 
+  /**
+     * 删除企业扩展服务授权，当前仅支持 “企业自动签” 取消授权。
+
+注：支持集团代子企业操作，请联系运营开通此功能。
+     */
+  async DeleteExtendedServiceAuthInfos(
+    req: DeleteExtendedServiceAuthInfosRequest,
+    cb?: (error: string, rep: DeleteExtendedServiceAuthInfosResponse) => void
+  ): Promise<DeleteExtendedServiceAuthInfosResponse> {
+    return this.request("DeleteExtendedServiceAuthInfos", req, cb)
+  }
+
   /**
    * 此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。
    */

package/src/services/ess/v20201111/ess_models.ts

@@ -39,7 +39,8 @@ export interface CreateSealRequest {
    */
   Operator: UserInfo
   /**
-   * 电子印章名字，1-50个中文字符。
+   * 电子印章名字，1-50个中文字符
+注:`同一企业下电子印章名字不能相同`
    */
   SealName: string
   /**
@@ -48,19 +49,21 @@ export interface CreateSealRequest {
    */
   Agent?: Agent
   /**
-   * 本接口支持上传图片印章及系统直接生成印章；
-如果要使用系统生成印章，此值传：SealGenerateSourceSystem；
-如果要使用图片上传请传字段 Image
+   * 电子印章生成方式
+<ul>
+<li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
+<li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
+</ul>
    */
   GenerateSource?: string
   /**
-   * 电子印章类型：
-<ul>
-<li>OFFICIAL-公章；</li>
-<li>CONTRACT-合同专用章;</li>
-<li>FINANCE-合财务专用章;</li>
-<li>PERSONNEL-人事专用章.</li>
+   * 电子印章类型 , 可选类型如下: 
+<ul><li>**OFFICIAL**: (默认)公章</li>
+<li>**CONTRACT**: 合同专用章;</li>
+<li>**FINANCE**: 合财务专用章;</li>
+<li>**PERSONNEL**: 人事专用章</li>
 </ul>
+注: `同企业下只能有一个公章, 重复创建会报错`
    */
   SealType?: string
   /**
@@ -68,8 +71,11 @@ export interface CreateSealRequest {
    */
   FileName?: string
   /**
-   * 电子印章图片base64编码
-参数Image,FileToken或GenerateSource=SealGenerateSourceSystem三选一。
+   * 电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式
+
+注: `通过图片创建的电子印章，需电子签平台人工审核`
+
+
    */
   Image?: string
   /**
@@ -89,7 +95,11 @@ export interface CreateSealRequest {
    */
   Color?: string
   /**
-   * 企业印章横向文字，最多可填15个汉字（若超过印章最大宽度，优先压缩字间距，其次缩小字号）
+   * 企业印章横向文字，最多可填15个汉字  (若超过印章最大宽度，优先压缩字间距，其次缩小字号)
+横向文字的位置如下图中的"印章横向文字在这里"
+
+![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png)
+
    */
   SealHorizontalText?: string
   /**
@@ -106,22 +116,16 @@ export interface CreateSealRequest {
    */
   FileToken?: string
   /**
-   * 印章样式，取值如下:
-
-<ul>
-<li>cycle:圆形印章;</li>
-<li>ellipse:椭圆印章;</li>
-<li>注：默认圆形印章</li>
-</ul>
+   * 印章样式, 可以选择的样式如下: 
+<ul><li>**cycle**:(默认)圆形印章</li>
+<li>**ellipse**:椭圆印章</li>
    */
   SealStyle?: string
   /**
-   * 印章尺寸取值描述：
-<ul>
-<li>42_42 圆形企业公章直径42mm；</li>
-<li>40_40 圆形企业印章直径40mm；</li>
-<li>45_30 椭圆形印章45mm x 30mm;</li>
-</ul>
+   * 印章尺寸取值描述, 可以选择的尺寸如下: 
+<ul><li> **42_42**: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li>
+<li> **40_40**: 圆形企业印章直径40mm, 当SealStyle是圆形的时候才有效</li>
+<li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
    */
   SealSize?: string
 }
@@ -297,6 +301,16 @@ export interface DescribeIntegrationDepartmentsResponse {
   RequestId?: string
 }
 
+/**
+ * DeleteExtendedServiceAuthInfos返回参数结构体
+ */
+export interface DeleteExtendedServiceAuthInfosResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateFlowApprovers返回参数结构体
  */
@@ -333,6 +347,35 @@ export interface DescribeFileUrlsResponse {
   RequestId?: string
 }
 
+/**
+ * CreateExtendedServiceAuthInfos请求参数结构体
+ */
+export interface CreateExtendedServiceAuthInfosRequest {
+  /**
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+   */
+  Operator: UserInfo
+  /**
+   * 本企业员工的id，需要已实名，正常在职员工
+   */
+  UserIds: Array<string>
+  /**
+   * 要查询的扩展服务类型。
+默认为空，即查询当前支持的所有扩展服务信息。
+若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+<ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+</ul>
+
+   */
+  ExtendServiceType?: string
+  /**
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   */
+  Agent?: Agent
+}
+
 /**
  * ModifyApplicationCallbackInfo返回参数结构体
  */
@@ -3696,15 +3739,15 @@ export interface CreateDocumentRequest {
    * 是否为预览模式，取值如下：
 <ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
 <li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
-注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容`
+注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知`
    */
   NeedPreview?: boolean
   /**
    * 预览模式下产生的预览链接类型 
 <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
-<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
-注: `此参数在NeedPreview 为true时有效`
-
+<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>
+注: `1.此参数在NeedPreview 为true时有效`
+`2.动态表格控件不支持H5链接方式预览`
    */
   PreviewType?: number
   /**
@@ -4932,6 +4975,16 @@ export interface FailedCreateStaffData {
   Reason?: string
 }
 
+/**
+ * CreateExtendedServiceAuthInfos返回参数结构体
+ */
+export interface CreateExtendedServiceAuthInfosResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 指定签署人限制项
  */
@@ -6543,6 +6596,35 @@ export interface DescribeFlowInfoRequest {
   FlowGroupId?: string
 }
 
+/**
+ * DeleteExtendedServiceAuthInfos请求参数结构体
+ */
+export interface DeleteExtendedServiceAuthInfosRequest {
+  /**
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+   */
+  Operator: UserInfo
+  /**
+   * 本企业员工的id，需要已实名，正常在职员工
+   */
+  UserIds: Array<string>
+  /**
+   * 要查询的扩展服务类型。
+默认为空，即查询当前支持的所有扩展服务信息。
+若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+<ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+</ul>
+
+   */
+  ExtendServiceType?: string
+  /**
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   */
+  Agent?: Agent
+}
+
 /**
  * DescribeIntegrationDepartments请求参数结构体
  */

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

@@ -339,8 +339,12 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 通过图片为子客企业代创建印章，图片最大5MB
-   */
+     * 1. 可以**通过图片**为子客企业代创建印章，图片最大5MB
+
+2. 可以**系统创建**子客企业代创建印章, 系统创建的印章样子下图(样式可以调整)
+
+![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage.png)
+     */
   async CreateSealByImage(
     req: CreateSealByImageRequest,
     cb?: (error: string, rep: CreateSealByImageResponse) => void
@@ -349,8 +353,10 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
-   */
+     * 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
+该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
+如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
+     */
   async ChannelCancelMultiFlowSignQRCode(
     req: ChannelCancelMultiFlowSignQRCodeRequest,
     cb?: (error: string, rep: ChannelCancelMultiFlowSignQRCodeResponse) => void
@@ -365,6 +371,7 @@ export class Client extends AbstractClient {
 3. 使用手机号验证签署方身份
 4. 骑缝章
 5. 拓宽签署方年龄限制
+6. 下载企业合同/文件
 
 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
      */
@@ -823,10 +830,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-     * 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息
-注意:
-该接口不可直接调用，请联系客户经理申请使用
-仅能催办当前状态为“待签署”的签署人，且只能催办一次
+     * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+
+1. 合同中当前状态为“待签署”的签署人是催办的对象
+2. 每个合同只能催办一次
+
+注意：该接口无法直接调用，请联系客户经理申请使用。
      */
   async ChannelCreateFlowReminds(
     req: ChannelCreateFlowRemindsRequest,
@@ -1000,8 +1009,66 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 接口（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: ChannelCreateFlowGroupByTemplatesRequest,
     cb?: (error: string, rep: ChannelCreateFlowGroupByTemplatesResponse) => void
@@ -1110,8 +1177,69 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-   * 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
-   */
+     * 接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
+
+合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+
+
+**注**: 
+<ul>
+<li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+<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: ChannelCreateFlowGroupByFilesRequest,
     cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void