tencentcloud-sdk-nodejs 4.0.719 → 4.0.720

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

@@ -831,6 +831,20 @@ export interface StaffRole {
   RoleName?: string
 }
 
+/**
+ * CreateBatchQuickSignUrl返回参数结构体
+ */
+export interface CreateBatchQuickSignUrlResponse {
+  /**
+   * 签署人签署链接信息
+   */
+  FlowApproverUrlInfo?: FlowApproverUrlInfo
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateIntegrationRole请求参数结构体
  */
@@ -3447,7 +3461,7 @@ export interface FlowCreateApprover {
 </li></ul>
 注: 
 <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式,    则忽略此签署人的查看合同的校验方式</li>
-<li>此字段不可传多个校验方式</li></ul>
+<li>此字段可传多个校验方式</li></ul>
 
 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
 
@@ -4680,7 +4694,9 @@ export interface ApproverInfo {
    */
   ApproverRole?: number
   /**
-   * 自定义签署人角色名：收款人、开具人、见证人
+   * 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。
+
+注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
    */
   ApproverRoleName?: string
   /**
@@ -4727,7 +4743,7 @@ export interface ApproverInfo {
 </li></ul>
 注: 
 <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式,    则忽略此签署人的查看合同的校验方式</li>
-<li>此字段不可传多个校验方式</li></ul>
+<li>此字段可传多个校验方式</li></ul>
    */
   ApproverVerifyTypes?: Array<number | bigint>
   /**
@@ -6774,6 +6790,57 @@ export interface FilledComponent {
   ImageUrl?: string
 }
 
+/**
+ * CreateBatchQuickSignUrl请求参数结构体
+ */
+export interface CreateBatchQuickSignUrlRequest {
+  /**
+   * 批量签署的合同流程ID数组。
+注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
+   */
+  FlowIds: Array<string>
+  /**
+   * 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
+注:
+`1. ApproverType目前只支持个人类型的签署人。`
+`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
+   */
+  FlowApproverInfo: FlowCreateApprover
+  /**
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId(子企业的组织ID)为必填项。
+   */
+  Agent?: Agent
+  /**
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+   */
+  Operator?: UserInfo
+  /**
+   * 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
+   */
+  JumpUrl?: string
+  /**
+   * 指定批量签署合同的签名类型，可传递以下值：
+<ul><li>**0**：手写签名(默认)</li>
+<li>**1**：OCR楷体</li></ul>
+注：
+<ul><li>默认情况下，签名类型为手写签名</li>
+<li>您可以传递多种值，表示可用多种签名类型。</li></ul>
+   */
+  SignatureTypes?: Array<number | bigint>
+  /**
+   * 指定批量签署合同的认证校验方式，可传递以下值：
+<ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
+<li>**3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
+注：
+<ul><li>默认情况下，认证校验方式为人脸认证</li>
+<li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
+   */
+  ApproverSignTypes?: Array<number | bigint>
+}
+
 /**
  * 下载文件的URL信息
  */

package/src/services/essbasic/index.ts

@@ -1,7 +1,7 @@
-import { v20210526 } from "./v20210526"
 import { v20201222 } from "./v20201222"
+import { v20210526 } from "./v20210526"
 
 export const essbasic = {
-  v20210526: v20210526,
   v20201222: v20201222,
+  v20210526: v20210526,
 }

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

@@ -59,6 +59,7 @@ import {
   ChannelCreateWebThemeConfigRequest,
   ChannelCreateConvertTaskApiRequest,
   ChannelCreateFlowByFilesRequest,
+  UploadFilesResponse,
   Agent,
   ChannelCreatePreparedPersonalEsignResponse,
   FlowApproverDetail,
@@ -107,6 +108,7 @@ import {
   ChannelCreateUserAutoSignSealUrlResponse,
   ApproverComponentLimitType,
   ResourceUrlInfo,
+  ChannelCreateBatchQuickSignUrlRequest,
   ChannelCreateBoundFlowsRequest,
   ChannelDescribeEmployeesRequest,
   AuthorizedUser,
@@ -137,7 +139,7 @@ import {
   FlowApproverItem,
   CreateSignUrlsResponse,
   ChannelDeleteRoleRequest,
-  UploadFilesResponse,
+  ChannelCreateBatchQuickSignUrlResponse,
   ChannelCreateBatchCancelFlowUrlRequest,
   ApproverRestriction,
   PrepareFlowsRequest,
@@ -232,6 +234,42 @@ export class Client extends AbstractClient {
     return this.request("ChannelCreateFlowSignReview", req, cb)
   }
 
+  /**
+     * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。
+
+跳转小程序的几种方式：主要是设置不同的EndPoint
+1. 通过链接Url直接跳转到小程序，不需要返回
+设置EndPoint为WEIXINAPP，得到链接打开即可。
+
+2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
+跳转到小程序的实现，参考官方文档
+https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
+其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+设置EndPoint为APP，得到path。
+
+4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
+跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
+全屏方式：
+（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
+半屏方式：
+（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）
+其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
+设置EndPoint为APP，得到path。
+
+其中小程序的原始Id如下，或者查看小程序信息自助获取。
+
+| 小程序 | AppID | 原始ID |
+| ------------ | ------------ | ------------ |
+| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
+| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
+     */
+  async ModifyExtendedService(
+    req: ModifyExtendedServiceRequest,
+    cb?: (error: string, rep: ModifyExtendedServiceResponse) => void
+  ): Promise<ModifyExtendedServiceResponse> {
+    return this.request("ModifyExtendedService", req, cb)
+  }
+
   /**
      * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 
 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
@@ -383,44 +421,26 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。
-
-跳转小程序的几种方式：主要是设置不同的EndPoint
-1. 通过链接Url直接跳转到小程序，不需要返回
-设置EndPoint为WEIXINAPP，得到链接打开即可。
-
-2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
-跳转到小程序的实现，参考官方文档
-https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
-其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
-设置EndPoint为APP，得到path。
-
-4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
-跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式）
-全屏方式：
-（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html）
-半屏方式：
-（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html）
-其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
-设置EndPoint为APP，得到path。
-
-其中小程序的原始Id如下，或者查看小程序信息自助获取。
-
-| 小程序 | AppID | 原始ID |
-| ------------ | ------------ | ------------ |
-| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
-| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
+     * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
+相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355
      */
-  async ModifyExtendedService(
-    req: ModifyExtendedServiceRequest,
-    cb?: (error: string, rep: ModifyExtendedServiceResponse) => void
-  ): Promise<ModifyExtendedServiceResponse> {
-    return this.request("ModifyExtendedService", req, cb)
+  async ChannelDescribeRoles(
+    req: ChannelDescribeRolesRequest,
+    cb?: (error: string, rep: ChannelDescribeRolesResponse) => void
+  ): Promise<ChannelDescribeRolesResponse> {
+    return this.request("ChannelDescribeRoles", req, cb)
   }
 
   /**
-   * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
-   */
+     * 此接口（ChannelCreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
+前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
+适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
+适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
+转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
+注: 
+1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
+2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
+     */
   async ChannelCreateConvertTaskApi(
     req: ChannelCreateConvertTaskApiRequest,
     cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void
@@ -482,17 +502,20 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
   }
 
   /**
-     * 此接口（ChannelCreateRole）用来创建企业自定义角色。
-
-适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
-
-适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
+     * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
+`注意：`<br/>
+`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
+`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
+`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。` <br/>
+`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。` <br/>
+`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`<br/>
+跳转到小程序的实现，参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式)，如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
      */
-  async ChannelCreateRole(
-    req: ChannelCreateRoleRequest,
-    cb?: (error: string, rep: ChannelCreateRoleResponse) => void
-  ): Promise<ChannelCreateRoleResponse> {
-    return this.request("ChannelCreateRole", req, cb)
+  async ChannelCreateBatchQuickSignUrl(
+    req: ChannelCreateBatchQuickSignUrlRequest,
+    cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void
+  ): Promise<ChannelCreateBatchQuickSignUrlResponse> {
+    return this.request("ChannelCreateBatchQuickSignUrl", req, cb)
   }
 
   /**
@@ -607,6 +630,11 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
 >- 填写控件 Components
 >- 签署控件 SignComponents
 >- 生成模板的文件基础信息 FileInfos
+
+注意：
+
+>1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。
+>2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准
      */
   async DescribeTemplates(
     req: DescribeTemplatesRequest,
@@ -739,8 +767,12 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。
-注意：大文件转换所需的时间可能会比较长。
+     * 此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
+前提条件：已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换，并得到了返回的转换任务Id。<br />
+
+适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。<br />
+注：
+1. `大文件转换所需的时间可能会比较长`
      */
   async ChannelGetTaskResultApi(
     req: ChannelGetTaskResultApiRequest,
@@ -854,18 +886,16 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
-
-1. 合同中当前状态为“待签署”的签署人是催办的对象
-2. 每个合同只能催办一次
-
-注意：该接口无法直接调用，请联系客户经理申请使用。
+     * 该接口用于发起合同后，生成C端签署人的签署链接<br/>
+注意：该接口目前签署人类型仅支持个人签署方（PERSON）<br/>
+注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
+注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
      */
-  async ChannelCreateFlowReminds(
-    req: ChannelCreateFlowRemindsRequest,
-    cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void
-  ): Promise<ChannelCreateFlowRemindsResponse> {
-    return this.request("ChannelCreateFlowReminds", req, cb)
+  async ChannelCreateFlowSignUrl(
+    req: ChannelCreateFlowSignUrlRequest,
+    cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void
+  ): Promise<ChannelCreateFlowSignUrlResponse> {
+    return this.request("ChannelCreateFlowSignUrl", req, cb)
   }
 
   /**
@@ -917,7 +947,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   /**
      * 该接口 (PrepareFlows) 用于创建待发起文件
 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-目前该接口只支持B2C，不建议使用，将会废弃。
+目前该接口只支持B2C，不建议使用，将会**废弃**。
      */
   async PrepareFlows(
     req: PrepareFlowsRequest,
@@ -959,14 +989,17 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
   }
 
   /**
-     * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
-相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355
+     * 此接口（ChannelCreateRole）用来创建企业自定义角色。
+
+适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
+
+适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
      */
-  async ChannelDescribeRoles(
-    req: ChannelDescribeRolesRequest,
-    cb?: (error: string, rep: ChannelDescribeRolesResponse) => void
-  ): Promise<ChannelDescribeRolesResponse> {
-    return this.request("ChannelDescribeRoles", req, cb)
+  async ChannelCreateRole(
+    req: ChannelCreateRoleRequest,
+    cb?: (error: string, rep: ChannelCreateRoleResponse) => void
+  ): Promise<ChannelCreateRoleResponse> {
+    return this.request("ChannelCreateRole", req, cb)
   }
 
   /**
@@ -1033,16 +1066,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
   }
 
   /**
-     * 该接口用于发起合同后，生成C端签署人的签署链接<br/>
-注意：该接口目前签署人类型仅支持个人签署方（PERSON）<br/>
-注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
-注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
+     * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+
+1. 合同中当前状态为“待签署”的签署人是催办的对象
+2. 每个合同只能催办一次
+
+注意：该接口无法直接调用，请联系客户经理申请使用。
      */
-  async ChannelCreateFlowSignUrl(
-    req: ChannelCreateFlowSignUrlRequest,
-    cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void
-  ): Promise<ChannelCreateFlowSignUrlResponse> {
-    return this.request("ChannelCreateFlowSignUrl", req, cb)
+  async ChannelCreateFlowReminds(
+    req: ChannelCreateFlowRemindsRequest,
+    cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void
+  ): Promise<ChannelCreateFlowRemindsResponse> {
+    return this.request("ChannelCreateFlowReminds", req, cb)
   }
 
   /**