tencentcloud-sdk-nodejs-essbasic 4.1.229 → 4.1.230

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-essbasic",
3
- "version": "4.1.229",
3
+ "version": "4.1.230",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -3676,130 +3676,85 @@ export interface SignUrlInfo {
3676
3676
  */
3677
3677
  export interface CommonFlowApprover {
3678
3678
  /**
3679
- * 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
3680
- <ul>
3681
- <li>false: 默认值,第三方平台子客企业下员工</li>
3682
- <li>true: SaaS平台企业下的员工</li>
3683
- </ul>
3684
-
3679
+ * <p>指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。</p><ul><li>false: 默认值,第三方平台子客企业下员工</li><li>true: SaaS平台企业下的员工</li></ul>
3685
3680
  */
3686
3681
  NotChannelOrganization?: boolean;
3687
3682
  /**
3688
- * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
3689
-
3690
- **0** :企业/企业员工(企业签署方或模板发起时的企业静默签)
3691
- **1** :个人/自然人
3692
- **3** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)
3693
-
3694
- 注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
3695
- 使用自动签时,请确保企业已经开通自动签功能,开通方式:控制台 -> 企业设置 -> 扩展服务 -> 企业自动签。
3696
- 使用文件发起自动签时使用前请联系对接的客户经理沟通。
3697
-
3683
+ * <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:</p><p> <strong>0</strong> :企业/企业员工(企业签署方或模板发起时的企业静默签)<br> <strong>1</strong> :个人/自然人<br><strong>3</strong> :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</p><p>注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。<br>使用自动签时,请确保企业已经开通自动签功能,开通方式:控制台 -&gt; 企业设置 -&gt; 扩展服务 -&gt; 企业自动签。<br>使用文件发起自动签时使用前请联系对接的客户经理沟通。</p>
3698
3684
  */
3699
3685
  ApproverType?: number;
3700
3686
  /**
3701
- * 电子签平台给企业生成的企业id
3687
+ * <p>电子签平台给企业生成的企业id</p>
3702
3688
  */
3703
3689
  OrganizationId?: string;
3704
3690
  /**
3705
- * 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传
3691
+ * <p>企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传</p>
3706
3692
  */
3707
3693
  OrganizationOpenId?: string;
3708
3694
  /**
3709
- * 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
3695
+ * <p>企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传</p>
3710
3696
  */
3711
3697
  OrganizationName?: string;
3712
3698
  /**
3713
- * 电子签平台给企业员工或者自热人生成的用户id
3699
+ * <p>电子签平台给企业员工或者自热人生成的用户id</p>
3714
3700
  */
3715
3701
  UserId?: string;
3716
3702
  /**
3717
- * 第三方平台子客企业员工的唯一标识
3703
+ * <p>第三方平台子客企业员工的唯一标识</p>
3718
3704
  */
3719
3705
  OpenId?: string;
3720
3706
  /**
3721
- * 签署方经办人的姓名。
3722
- 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
3707
+ * <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
3723
3708
  */
3724
3709
  ApproverName?: string;
3725
3710
  /**
3726
- * 签署人手机号,saas企业签署人,个人签署人必传
3711
+ * <p>签署人手机号,saas企业签署人,个人签署人必传</p>
3727
3712
  */
3728
3713
  ApproverMobile?: string;
3729
3714
  /**
3730
- * 签署方经办人的证件类型,支持以下类型
3731
- <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
3732
- <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
3733
- <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
3734
- <li>OTHER_CARD_TYPE : 其他证件</li></ul>
3735
-
3736
- 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
3715
+ * <p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li><li>OTHER_CARD_TYPE : 其他证件</li></ul><p>注: <code>其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
3737
3716
  */
3738
3717
  ApproverIdCardType?: string;
3739
3718
  /**
3740
- * 签署方经办人的证件号码,应符合以下规则
3741
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3742
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。
3743
- </li>
3744
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3719
+ * <p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3745
3720
  */
3746
3721
  ApproverIdCardNumber?: string;
3747
3722
  /**
3748
- * 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
3749
- 注意:模板发起时该字段必填
3723
+ * <p>签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId<br>注意:模板发起时该字段必填</p>
3750
3724
  */
3751
3725
  RecipientId?: string;
3752
3726
  /**
3753
- * 签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s
3727
+ * <p>签署前置条件:阅读时长限制,不传默认10s,最大300s,最小3s</p>
3754
3728
  */
3755
3729
  PreReadTime?: number;
3756
3730
  /**
3757
- * 签署前置条件:阅读全文限制
3731
+ * <p>签署前置条件:阅读全文限制</p>
3758
3732
  */
3759
3733
  IsFullText?: boolean;
3760
3734
  /**
3761
- * 通知签署方经办人的方式, 有以下途径:
3762
- <ul><li> **SMS** :(默认)短信</li>
3763
- <li> **NONE** : 不通知</li></ul>
3764
-
3765
- 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
3735
+ * <p>通知签署方经办人的方式, 有以下途径:</p><ul><li> **SMS** :(默认)短信</li><li> **NONE** : 不通知</li></ul><p>注: <code>签署方为第三方子客企业时会被置为NONE, 不会发短信通知</code></p>
3766
3736
  */
3767
3737
  NotifyType?: string;
3768
3738
  /**
3769
- * 签署人配置,用于控制签署人相关属性
3739
+ * <p>签署人配置,用于控制签署人相关属性</p>
3770
3740
  */
3771
3741
  ApproverOption?: CommonApproverOption;
3772
3742
  /**
3773
- * 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID
3743
+ * <p>使用PDF文件直接发起合同时,签署人指定的签署控件;<br>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。</p>
3774
3744
  */
3775
3745
  SignComponents?: Array<Component>;
3776
3746
  /**
3777
- * 指定个人签署方查看合同的校验方式,可以传值如下:
3778
- <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
3779
- <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
3780
- </li></ul>
3781
- 注:
3782
- <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
3783
- <li>此字段可传多个校验方式</li></ul>
3747
+ * <p>指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li><li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul>
3784
3748
  */
3785
3749
  ApproverVerifyTypes?: Array<number | bigint>;
3786
3750
  /**
3787
- * 签署人签署合同时的认证方式
3788
- <ul><li> **1** :人脸认证</li>
3789
- <li> **2** :签署密码</li>
3790
- <li> **3** :运营商三要素</li>
3791
- <li> **5** :设备指纹识别</li>
3792
- <li> **6** :设备面容识别</li></ul>
3793
-
3794
- 默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
3795
-
3796
- 注:
3797
- 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
3798
- 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
3799
- 3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。
3800
- 4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。
3751
+ * <p>签署人签署合同时的认证方式</p><ul><li> **1** :人脸认证</li><li> **2** :签署密码</li><li> **3** :运营商三要素</li><li> **5** :设备指纹识别</li><li> **6** :设备面容识别</li></ul><p>默认为1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)</p><p>注: </p><ol><li>用<font color="red">模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color="red">在创建合同重新指定无效</font></li><li>运营商三要素认证方式对手机号运营商及前缀有限制,可以参考<a href="https://qian.tencent.com/developers/partner/mobile_support">运营商支持列表类</a>得到具体的支持说明</li><li>校验方式不允许只包含<font color="red">设备指纹识别</font>和<font color="red">设备面容识别</font>,至少需要再增加一种其他校验方式。</li><li><font color="red">设备指纹识别</font>和<font color="red">设备面容识别</font>只支持小程序使用,其他端暂不支持。</li></ol>
3801
3752
  */
3802
3753
  ApproverSignTypes?: Array<number | bigint>;
3754
+ /**
3755
+ * <p>签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。</p><p>枚举值:</p><ul><li>HANDWRITE: 手写签名</li><li>ESIGN: 个人印章类型</li><li>OCR_ESIGN: AI智能识别手写签名</li><li>SYSTEM_ESIGN: 系统签名</li></ul>
3756
+ */
3757
+ ComponentLimitType?: Array<string>;
3803
3758
  }
3804
3759
  /**
3805
3760
  * 指定补充签署人信息