tencentcloud-sdk-nodejs-essbasic 4.0.719 → 4.0.720

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

@@ -12,7 +12,7 @@ export interface SyncProxyOrganizationResponse {
  */
 export interface ChannelCreateConvertTaskApiResponse {
     /**
-     * 任务id
+     * 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
      */
     TaskId?: string;
     /**
@@ -1221,19 +1221,41 @@ export interface ChannelCreateWebThemeConfigRequest {
  */
 export interface ChannelCreateConvertTaskApiRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
+     * 需要进行转换的资源文件类型
+  支持的文件类型如下：
+  <ul><li>doc</li>
+  <li>docx</li>
+  <li>xls</li>
+  <li>xlsx</li>
+  <li>jpg</li>
+  <li>jpeg</li>
+  <li>png</li>
+  <li>bmp</li>
+  <li>txt</li></ul>
      */
     ResourceType: string;
     /**
-     * 资源名称，长度限制为256字符
+     * 需要进行转换操作的文件资源名称，带资源后缀名。
+  
+  注:  `资源名称长度限制为256个字符`
      */
     ResourceName: string;
     /**
-     * 文件Id，通过UploadFiles获取
+     * 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
+  
+  注:  `目前，此接口仅支持单个文件进行转换。`
      */
     ResourceId: string;
     /**
@@ -1387,6 +1409,30 @@ export interface ChannelCreateFlowByFilesRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * UploadFiles返回参数结构体
+ */
+export interface UploadFilesResponse {
+    /**
+     * 上传成功文件数量
+  注: `如果一个文件上传失败, 则全部文件皆上传失败`
+     */
+    TotalCount?: number;
+    /**
+     * 文件资源ID数组，每个文件资源ID为32位字符串。
+  建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
+  注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用`
+     */
+    FileIds?: Array<string>;
+    /**
+     * 对应上传文件的下载链接，过期时间5分钟
+     */
+    FileUrls?: Array<string>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 应用相关信息
  */
@@ -1907,15 +1953,15 @@ export interface Recipient {
  */
 export interface DescribeTemplatesResponse {
     /**
-     * 模板列表
+     * 模板详情列表数据
      */
     Templates?: Array<TemplateInfo>;
     /**
-     * 查询到的总数
+     * 查询到的模板总数
      */
     TotalCount?: number;
     /**
-     * 每页多少条数据
+     * 每页返回的数据条数
      */
     Limit?: number;
     /**
@@ -3154,15 +3200,19 @@ export interface FormField {
  */
 export interface FlowInfo {
     /**
-     * 合同名字，最大长度200个字符
+     * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
      */
     FlowName: string;
     /**
-     * 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
+     * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
+  如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
+  示例值：1604912664
      */
     Deadline: number;
     /**
-     * 模板ID
+     * 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
+  
+  可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
      */
     TemplateId?: string;
     /**
@@ -3174,42 +3224,70 @@ export interface FlowInfo {
      */
     FormFields?: Array<FormField>;
     /**
-     * 回调地址，最大长度1000个字符
+     * 合同状态变动结的通知回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性，最大长度1000个字符。
+  
+  腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
+  回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块
      */
     CallbackUrl?: string;
     /**
-     * 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符
+     * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
      */
     FlowType?: string;
     /**
-     * 合同描述，最大长度1000个字符
+     * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
      */
     FlowDescription?: string;
     /**
-     *  第三方应用平台的业务信息，最大长度1000个字符。
+     * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。
+  
+  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
      */
     CustomerData?: string;
     /**
-     * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+     * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
+  <ul><li>{合同名称}   </li>
+  <li>{发起方企业} </li>
+  <li>{发起方姓名} </li>
+  <li>{签署方N企业}</li>
+  <li>{签署方N姓名}</li></ul>
+  其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
+  
+  例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
+  
+  合同名称：租房合同
+  发起方：腾讯公司(张三)
+  签署方：李四
+  
+  
      */
     CustomShowMap?: string;
     /**
-     * 被抄送人的信息列表，抄送功能暂不开放
+     * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
+  
+  注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。`
      */
     CcInfos?: Array<CcInfo>;
     /**
-     * 发起方企业的签署人进行签署操作是否需要企业内部审批。
-  若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
-  
-  注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+     * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
+  <ul><li> **false**：（默认）不需要审批，直接签署。</li>
+  <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
+  企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
+  <ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
+  <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
+  注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
      */
     NeedSignReview?: boolean;
     /**
-     * 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
+     * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
+  <ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
+  <li> **1** : 签署完成后通知对方来查看合同</li></ul>
      */
     CcNotifyType?: number;
     /**
-     * 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+     * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
+  <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签）  </li></ul>
+  注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
      */
     AutoSignScene?: string;
 }
@@ -3336,6 +3414,50 @@ export interface ResourceUrlInfo {
      */
     Type?: string;
 }
+/**
+ * ChannelCreateBatchQuickSignUrl请求参数结构体
+ */
+export interface ChannelCreateBatchQuickSignUrlRequest {
+    /**
+     * 批量签署的合同流程ID数组。
+  注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
+     */
+    FlowIds: Array<string>;
+    /**
+     * 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
+  注:
+  `1. ApproverType目前只支持个人类型的签署人。`
+  `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+  `3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
+     */
+    FlowApproverInfo: FlowApproverInfo;
+    /**
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+     */
+    Agent?: Agent;
+    /**
+     * 签署完之后的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>;
+}
 /**
  * ChannelCreateBoundFlows请求参数结构体
  */
@@ -3815,9 +3937,13 @@ export interface FlowApproverInfo {
      */
     ApproverNeedSignReview?: boolean;
     /**
-     * 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
-  查看合同的认证方式 Flow层级的优先于approver层级的
-  （当手写签名方式为OCR_ESIGN时，合同认证方式2无效，因为这种签名方式依赖实名认证）
+     * 指定个人签署方查看合同的校验方式,可以传值如下:
+  <ul><li>  **1**   : （默认）人脸识别,人脸识别后才能合同内容</li>
+  <li>  **2**  : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
+  </li></ul>
+  注:
+  <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式,    则忽略此签署人的查看合同的校验方式</li>
+  <li>此字段可传多个校验方式</li></ul>
      */
     ApproverVerifyTypes?: Array<number | bigint>;
     /**
@@ -3852,7 +3978,9 @@ export interface FlowApproverInfo {
      */
     AddSignComponentsLimits?: Array<ComponentLimit>;
     /**
-     * 自定义签署人角色名，如收款人、开具人、见证人等
+     * 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。
+  
+  注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
      */
     ApproverRoleName?: string;
 }
@@ -3894,11 +4022,19 @@ export interface ChannelCreateUserAutoSignEnableUrlResponse {
  */
 export interface ChannelGetTaskResultApiRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 任务Id，通过ChannelCreateConvertTaskApi接口获得
+     * 转换任务Id，通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
      */
     TaskId: string;
     /**
@@ -4329,24 +4465,13 @@ export interface ChannelDeleteRoleRequest {
     RoleIds: Array<string>;
 }
 /**
- * UploadFiles返回参数结构体
+ * ChannelCreateBatchQuickSignUrl返回参数结构体
  */
-export interface UploadFilesResponse {
-    /**
-     * 上传成功文件数量
-  注: `如果一个文件上传失败, 则全部文件皆上传失败`
-     */
-    TotalCount?: number;
-    /**
-     * 文件资源ID数组，每个文件资源ID为32位字符串。
-  建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
-  注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用`
-     */
-    FileIds?: Array<string>;
+export interface ChannelCreateBatchQuickSignUrlResponse {
     /**
-     * 对应上传文件的下载链接，过期时间5分钟
+     * 签署人签署链接信息
      */
-    FileUrls?: Array<string>;
+    FlowApproverUrlInfo?: FlowApproverUrlInfo;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -4639,6 +4764,10 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse {
  * 签署人个性化能力信息
  */
 export interface ApproverOption {
+    /**
+     * 是否可以拒签 默认false-可以拒签 true-不可以拒签
+     */
+    NoRefuse?: boolean;
     /**
      * 是否隐藏一键签署 默认false-不隐藏true-隐藏
      */
@@ -4750,26 +4879,26 @@ export interface ChannelGetTaskResultApiResponse {
     TaskId?: string;
     /**
      * 任务状态，需要关注的状态
-  0  :NeedTranform   - 任务已提交
-  4  :Processing     - 文档转换中
-  8  :TaskEnd        - 任务处理完成
-  -2 :DownloadFailed - 下载失败
-  -6 :ProcessFailed  - 转换失败
-  -13:ProcessTimeout - 转换文件超时
+  <ul><li>**0**  :NeedTranform   - 任务已提交</li>
+  <li>**4**  :Processing     - 文档转换中</li>
+  <li>**8**  :TaskEnd        - 任务处理完成</li>
+  <li>**-2** :DownloadFailed - 下载失败</li>
+  <li>**-6** :ProcessFailed  - 转换失败</li>
+  <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
      */
     TaskStatus?: number;
     /**
      * 状态描述，需要关注的状态
-  NeedTranform   - 任务已提交
-  Processing     - 文档转换中
-  TaskEnd        - 任务处理完成
-  DownloadFailed - 下载失败
-  ProcessFailed  - 转换失败
-  ProcessTimeout - 转换文件超时
+  <ul><li> **NeedTranform** : 任务已提交</li>
+  <li> **Processing** : 文档转换中</li>
+  <li> **TaskEnd** : 任务处理完成</li>
+  <li> **DownloadFailed** : 下载失败</li>
+  <li> **ProcessFailed** : 转换失败</li>
+  <li> **ProcessTimeout** : 转换文件超时</li></ul>
      */
     TaskMessage?: string;
     /**
-     * 资源Id，也是FileId，用于文件发起使用
+     * 资源Id，也是FileId，用于文件发起时使用
      */
     ResourceId?: string;
     /**
@@ -5170,55 +5299,90 @@ export interface ChannelCancelFlowRequest {
  */
 export interface DescribeTemplatesRequest {
     /**
-     * 应用相关信息。
-  此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 模板唯一标识，查询单个模板时使用
+     * 合同模板ID，为32位字符串。
+  建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
      */
     TemplateId?: string;
     /**
-     * 查询内容：
-  0-模板列表及详情（默认），
-  1-仅模板列表
+     * 查询内容控制
+  
+  <ul><li>**0**：模板列表及详情（默认）</li>
+  <li>**1**：仅模板列表</li></ul>
      */
     ContentType?: number;
     /**
-     * 指定每页多少条数据，如果不传默认为20，单页最大100。
+     * 合同模板ID数组，每一个合同模板ID为32位字符串。
+  建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+  
+  ```注意:
+  1. 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。
+  2. 请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。
+  3. 最多支持200个模板。
+  4. 若传递此参数，分页参数(Limit,Offset)无效```
+  
+     */
+    TemplateIds?: Array<string>;
+    /**
+     * 指定每页返回的数据条数，和Offset参数配合使用。
+  
+  注：`1.默认值为20，单页做大值为200。`
      */
     Limit?: number;
     /**
-     * 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。
+     * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。
+  
+  注：`1.offset从0开始，即第一页为0。`
+  `2.默认从第一页返回。`
      */
     Offset?: number;
     /**
-     * 是否返回所有组件信息。
-  默认false，只返回发起方控件；
-  true，返回所有签署方控件
+     * 模糊搜索的模板名称，注意是模板名的连续部分，最大长度200
      */
-    QueryAllComponents?: boolean;
+    TemplateName?: string;
     /**
-     * 模糊搜索模板名称，最大长度200
+     * 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
      */
-    TemplateName?: string;
+    ChannelTemplateId?: string;
+    /**
+     * 是否返回所有控件信息。
+  
+  <ul><li>**false**：只返回发起方控件（默认）</li>
+  <li>**true**：返回所有签署方控件</li></ul>
+     */
+    QueryAllComponents?: boolean;
     /**
-     * 是否获取模板预览链接，
-  默认false-不获取
-  true-获取
+     * 是否获取模板预览链接。
+  
+  <ul><li>**false**：不获取（默认）</li>
+  <li>**true**：获取</li></ul>
+  
+  设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,有效期5分钟。
+  可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
+  （此功能开放需要联系客户经理）
      */
     WithPreviewUrl?: boolean;
     /**
      * 是否获取模板的PDF文件链接。
-  默认false-不获取
-  true-获取
-  请联系客户经理开白后使用。
+  
+  <ul><li>**false**：不获取（默认）</li>
+  <li>**true**：获取</li></ul>
+  
+  设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟。
+  （此功能开放需要联系客户经理）
      */
     WithPdfUrl?: boolean;
-    /**
-     * 对应第三方应用平台企业的模板ID
-     */
-    ChannelTemplateId?: string;
     /**
      * 操作者的信息
      * @deprecated