tencentcloud-sdk-nodejs-ess 4.1.133 → 4.1.137

package/package.json

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

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -4261,6 +4261,26 @@ export interface CreateIntegrationDepartmentResponse {
      */
     RequestId?: string;
 }
+/**
+ * 跳转事件的结构体，其中包括认证期间收录，授权书审核，企业认证的回跳事件。
+ */
+export interface JumpEvent {
+    /**
+     * 跳转事件枚举，
+     * 1 - 企业收录。
+     * 2 - 超管授权书审核。
+     * 3 - 认证完成。
+     */
+    JumpEventType?: number;
+    /**
+     * 为认证成功后页面进行回跳的URL，请确保回跳地址的可用性。
+  Endpoint如果是APP 类型，请传递<font color="red">"true"</font>
+  如果 Endpoint 是 H5 类型，请参考文档[跳转电子签H5](https://qian.tencent.com/developers/company/openqianh5/)
+  
+  p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。
+     */
+    JumpUrl?: string;
+}
 /**
  * DeleteSealPolicies返回参数结构体
  */
@@ -4341,30 +4361,26 @@ export interface UserThreeFactor {
     IdCardNumber: string;
 }
 /**
- * 更新员工信息失败返回的数据信息
+ * 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
  */
-export interface FailedUpdateStaffData {
-    /**
-     * 用户传入的名称
-     */
-    DisplayName?: string;
+export interface SignQrCode {
     /**
-     * 用户传入的手机号，明文展示
+     * 二维码ID，为32位字符串。
      */
-    Mobile?: string;
+    QrCodeId?: string;
     /**
-     * 失败原因
+     * 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
      */
-    Reason?: string;
+    QrCodeUrl?: string;
     /**
-     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
-  可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
+     * 二维码的有截止时间，格式为Unix标准时间戳（秒）。
+  一旦超过二维码的有效期限，该二维码将自动失效。
      */
-    UserId?: string;
+    ExpiredTime?: number;
     /**
-     * 员工在第三方平台的openId
+     * 微信小程序二维码
      */
-    OpenId?: string;
+    WeixinQrCodeUrl?: string;
 }
 /**
  * CreateSealPolicy返回参数结构体
@@ -4585,26 +4601,30 @@ export interface DeleteIntegrationEmployeesRequest {
     Agent?: Agent;
 }
 /**
- * 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
+ * 更新员工信息失败返回的数据信息
  */
-export interface SignQrCode {
+export interface FailedUpdateStaffData {
     /**
-     * 二维码ID，为32位字符串。
+     * 用户传入的名称
      */
-    QrCodeId?: string;
+    DisplayName?: string;
     /**
-     * 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
+     * 用户传入的手机号，明文展示
      */
-    QrCodeUrl?: string;
+    Mobile?: string;
     /**
-     * 二维码的有截止时间，格式为Unix标准时间戳（秒）。
-  一旦超过二维码的有效期限，该二维码将自动失效。
+     * 失败原因
      */
-    ExpiredTime?: number;
+    Reason?: string;
     /**
-     * 微信小程序二维码
+     * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+  可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
      */
-    WeixinQrCodeUrl?: string;
+    UserId?: string;
+    /**
+     * 员工在第三方平台的openId
+     */
+    OpenId?: string;
 }
 /**
  * GetTaskResultApi请求参数结构体
@@ -6332,7 +6352,7 @@ export interface CreateFlowOption {
      */
     ForbidEditApprover?: boolean;
     /**
-     *   禁止设置设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
+     *   禁止设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
   
      */
     ForbidEditFlowProperties?: boolean;
@@ -6415,6 +6435,43 @@ export interface CreateFlowOption {
   <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
      */
     ForbidEditWatermark?: boolean;
+    /**
+     * 隐藏操作指引: 具体的控件类型如下
+  
+  <ul><li>1 : 操作指引入口</li>
+  <li>2 : 操作文档</li>
+  <li>3 : 操作视频</li>
+  </ul>
+  注：仅对新版页面生效
+     * @deprecated
+     */
+    HideOperationInstructions?: Array<number | bigint>;
+    /**
+     * 隐藏操作步骤: 具体的控件类型如下
+  
+  <ul><li>1 : 选择文件及签署方</li>
+  <li>2 : 补充文件内容</li>
+  <li>4 : 发起前合同信息与设置确认</li>
+  </ul>
+  注：仅对新版页面生效
+     */
+    HideOperationSteps?: Array<number | bigint>;
+    /**
+     * 本企业简称，注：仅对新版页面生效
+     */
+    SelfName?: string;
+    /**
+     * 发起后签署码隐藏，默认false，注：仅对新版页面生效
+     */
+    HideSignCodeAfterStart?: boolean;
+    /**
+     * 发起成功后是否预览合同 <ul><li>（默认） false -否</li> <li> true - 展示预览按钮</li></ul>
+     */
+    PreviewAfterStart?: boolean;
+    /**
+     * 发起成功之后是否签署合同，仅当前经办人作为签署人时生效 <ul><li>（默认） false -否</li> <li> true - 展示签署按钮</li></ul>
+     */
+    SignAfterStart?: boolean;
 }
 /**
  * DescribeContractDiffTaskWebUrl返回参数结构体
@@ -6505,7 +6562,9 @@ export interface CreateOrganizationAuthUrlRequest {
      */
     LegalName?: string;
     /**
-     * 认证完成跳回的链接，最长500个字符
+     * <font color="red">即将废弃</font>，入参请使用JumpEvents。
+  认证完成跳回的链接，最长500个字符。
+  
      */
     AutoJumpUrl?: string;
     /**
@@ -6623,6 +6682,15 @@ export interface CreateOrganizationAuthUrlRequest {
   p.s. 仅在对公打款不为空时有效
      */
     BankAccountNumberSame?: boolean;
+    /**
+     * 跳转事件，其中包括认证期间收录，授权书审核，企业认证的回跳事件。
+  p.s.
+  Endpoint如果是APP 类型，请传递JumpUrl为<font color="red">"true" </font>
+  如果 Endpoint 是 H5 类型，请参考文档跳转电子签H5
+  
+  p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。
+     */
+    JumpEvents?: Array<JumpEvent>;
 }
 /**
  * CreateIntegrationRole请求参数结构体
@@ -9255,6 +9323,10 @@ export interface CreateBatchQuickSignUrlRequest {
   3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
      */
     Intention?: Intention;
+    /**
+     * 用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。
+     */
+    VideoVerifyTimesLimit?: number;
     /**
      * 缓存签署人信息。在H5签署链接动态领取场景，首次填写后，选择缓存签署人信息，在下次签署人点击领取链接时，会自动将个人信息（姓名、身份证号、手机号）填入，否则需要每次手动填写。
   
@@ -9509,6 +9581,11 @@ export interface Component {
   <ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>
   <b>参数样例</b>：`{"UseSealSize":true}`
   
+  <font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：
+  <ul><li> <b>Values</b>：签署意见预设的需要用户填写的的文本</li>
+  <li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li></ul>
+  <b>参数样例</b>：`{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}`
+  
   <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
   <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
   场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。
@@ -11410,6 +11487,10 @@ export interface CreateFlowSignUrlRequest {
   
      */
     FlowApproverInfos?: Array<FlowCreateApprover>;
+    /**
+     * 用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。
+     */
+    VideoVerifyTimesLimit?: number;
     /**
      * 机构信息，暂未开放
      * @deprecated
@@ -11989,7 +12070,7 @@ export interface ApproverOption {
   
   
   注：
-  1. `使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
+  1. `使用动态签署人能力前，需登录腾讯电子签控制台打开服务开关`
   2. 此参数在嵌入式场景下无效。
      */
     FillType?: number;