tencentcloud-sdk-nodejs-essbasic 4.1.223 → 4.1.228

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-essbasic",
-  "version": "4.1.223",
+  "version": "4.1.228",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

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

@@ -5188,77 +5188,71 @@ export interface RegistrationOrganizationInfo {
  */
 export interface ChannelCreateMultiFlowSignQRCodeRequest {
     /**
-     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
-  
-  此接口下面信息必填。
-  <ul>
-  <li>渠道应用标识:  Agent.AppId</li>
-  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
-  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
-  </ul>
-  第三方平台子客企业和员工必须已经经过实名认证
+     * <p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识:  Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 合同模板ID，为32位字符串。
+     * <p>合同模板ID，为32位字符串。</p>
      */
     TemplateId: string;
     /**
-     * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
+     * <p>合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。</p>
      */
     FlowName: string;
     /**
-     * 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。 一旦发起流程数超越该限制，该二维码将自动失效。
+     * <p>通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。 一旦发起流程数超越该限制，该二维码将自动失效。</p>
      */
     MaxFlowNum?: number;
     /**
-     * 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。 最长设定期限不得超过30天。
+     * <p>合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。 最长设定期限不得超过30天。</p>
      */
     FlowEffectiveDay?: number;
     /**
-     * 二维码的有效期限，默认为7天，最高设定不得超过90天。 一旦超过二维码的有效期限，该二维码将自动失效。
+     * <p>在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：<br> <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p><p>枚举值：</p><ul><li>0： 合同</li><li>1： 文件</li><li>2： 协议</li><li>3： 文书</li></ul><p>默认值：0</p>
+     */
+    FlowDisplayType?: number;
+    /**
+     * <p>二维码的有效期限，默认为7天，最高设定不得超过90天。 一旦超过二维码的有效期限，该二维码将自动失效。</p>
      * @deprecated
      */
     QrEffectiveDay?: number;
     /**
-     * 指定签署人信息。 在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
+     * <p>指定签署人信息。 在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。</p>
      */
     Restrictions?: Array<ApproverRestriction>;
     /**
-     * 指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。
+     * <p>指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。</p>
      */
     ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>;
     /**
-     * 已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
-  <br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
-  <br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
+     * <p>已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置<br><br> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign<br><br> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83</p>
      * @deprecated
      */
     CallbackUrl?: string;
     /**
-     * 限制二维码用户条件（已弃用）
+     * <p>限制二维码用户条件（已弃用）</p>
      * @deprecated
      */
     ApproverRestrictions?: ApproverRestriction;
     /**
-     * 暂未开放
+     * <p>暂未开放</p>
      * @deprecated
      */
     Operator?: UserInfo;
     /**
-     * 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
+     * <p>禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。</p>
      */
     ForbidPersonalMultipleSign?: boolean;
     /**
-     * 合同流程名称是否应包含扫码签署人的信息，且遵循特定格式（flowname-姓名-手机号后四位）。 例如，通过参数FlowName设定的扫码发起合同名称为“员工入职合同”，当扫码人张三（手机号18800009527）扫码签署时，合同名称将自动生成为“员工入职合同-张三-9527”。
+     * <p>合同流程名称是否应包含扫码签署人的信息，且遵循特定格式（flowname-姓名-手机号后四位）。 例如，通过参数FlowName设定的扫码发起合同名称为“员工入职合同”，当扫码人张三（手机号18800009527）扫码签署时，合同名称将自动生成为“员工入职合同-张三-9527”。</p>
      */
     FlowNameAppendScannerInfo?: boolean;
     /**
-     * 签署二维码的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示，若为空，则使用FlowName
+     * <p>签署二维码的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示，若为空，则使用FlowName</p>
      */
     QrCodeName?: string;
     /**
-     * 签署二维码截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为签署二维码创建后的7天时截止，最长可设置为签署二维码创建后的365天时截止。
+     * <p>签署二维码截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为签署二维码创建后的7天时截止，最长可设置为签署二维码创建后的365天时截止。</p>
      */
     QrCodeExpiredOn?: number;
 }
@@ -7445,11 +7439,11 @@ export interface ChannelCreateFlowGroupByFilesResponse {
  */
 export interface ChannelCreateMultiFlowSignQRCodeResponse {
     /**
-     * 一码多签签署码的基本信息，用户可扫描该二维码进行签署操作。
+     * <p>一码多签签署码的基本信息，用户可扫描该二维码进行签署操作。</p>
      */
     QrCode?: SignQrCode;
     /**
-     * 一码多签签署码链接信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
+     * <p>一码多签签署码链接信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。</p>
      */
     SignUrls?: SignUrl;
     /**
@@ -7963,7 +7957,7 @@ export interface GetDownloadFlowUrlRequest {
  */
 export interface ChannelCreateEmbedWebUrlResponse {
     /**
-     * 嵌入的web链接，5分钟有效
+     * <p>嵌入的web链接，5分钟有效</p>
      */
     WebUrl?: string;
     /**
@@ -9482,74 +9476,33 @@ export interface OrganizationInfo {
  */
 export interface ChannelCreateEmbedWebUrlRequest {
     /**
-     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
-  
-  此接口下面信息必填。
-  <ul>
-  <li>渠道应用标识:  Agent.AppId</li>
-  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
-  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
-  </ul>
-  第三方平台子客企业和员工必须已经经过实名认证
+     * <p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识:  Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 要生成WEB嵌入界面的类型, 可以选择的值如下:
-  
-  <ul>
-  <li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
-  <li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li>
-  <li>MODIFY_TEMPLATE：生成修改模板的嵌入页面</li>
-  <li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li>
-  <li>PREVIEW_FLOW：生成预览合同文档的嵌入页面（H5链接，支持移动端的浏览器中打开）</li>
-  <li>PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面（仅支持PC的浏览器中打开）</li>
-  <li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
-  <li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
-  <li>EXTEND_SERVICE：生成扩展服务的嵌入页面</li>
-  </ul>
+     * <p>要生成WEB嵌入界面的类型, 可以选择的值如下: </p><ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li><li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li><li>MODIFY_TEMPLATE：生成修改模板的嵌入页面</li><li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li><li>PREVIEW_FLOW：生成预览合同文档的嵌入页面（H5链接，支持移动端的浏览器中打开）</li><li>PREVIEW_FLOW_DETAIL：生成预览合同详情的嵌入页面（仅支持PC的浏览器中打开）</li><li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li><li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li><li>EXTEND_SERVICE：生成扩展服务的嵌入页面</li></ul>
      */
     EmbedType: string;
     /**
-     * WEB嵌入的业务资源ID
-  
-  当EmbedType取值
-  <ul>
-  <li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE必填，取值为模板id</li>
-  <li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li>
-  <li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL必填，取值为合同id</li>
-  <li>为PREVIEW_SEAL_DETAIL必填，取值为印章id</li>
-  </ul>
-  
-  
-  注意：
-   1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务](https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi) 来进行转换成PDF资源。
+     * <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE必填，取值为模板id</li><li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li><li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL必填，取值为合同id</li><li>为PREVIEW_SEAL_DETAIL必填，取值为印章id</li></ul><p>注意：</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi">查询转换任务状态</a> 来进行转换成PDF资源。</li></ol>
      */
     BusinessId?: string;
     /**
-     * 是否隐藏控件，只有预览模板时生效
+     * <p>是否隐藏控件，只有预览模板时生效，目前字段已废弃，请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes#embedurloption">嵌入式页面url个性化参数Option</a> 的ShowTemplateComponent来指定是否展示or隐藏控件</p>
+     * @deprecated
      */
     HiddenComponents?: boolean;
     /**
-     * 渠道操作者信息
+     * <p>渠道操作者信息</p>
      * @deprecated
      */
     Operator?: UserInfo;
     /**
-     * 用户自定义参数
-  <ul>
-  <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
-  <li>指定后，创建，编辑，删除模板时，回调都会携带该userData</li>
-  <li>支持的格式：json字符串的BASE64编码字符串</li>
-  <li>示例：<ul>
-                   <li>json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9</li>
-                   <li>eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式</li>
-  </ul>
-  </li>
-  </ul>
+     * <p>用户自定义参数</p><ul><li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li><li>指定后，创建，编辑，删除模板时，回调都会携带该userData</li><li>支持的格式：json字符串的BASE64编码字符串</li><li>示例：<ul>                 <li>json字符串：{"ComeFrom":"xxx"}，BASE64编码：eyJDb21lRnJvbSI6Inh4eCJ9</li>                 <li>eyJDb21lRnJvbSI6Inh4eCJ9，为符合要求的userData数据格式</li></ul></li></ul>
      */
     UserData?: string;
     /**
-     * 个性化参数，用于控制页面展示内容
+     * <p>个性化参数，用于控制页面展示内容</p>
      */
     Option?: EmbedUrlOption;
 }