tencentcloud-sdk-python-ess 3.1.81__tar.gz → 3.1.82__tar.gz

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.
Files changed (17) hide show
  1. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/setup.py +1 -1
  3. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud/ess/v20201111/models.py +161 -288
  5. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
  6. tencentcloud_sdk_python_ess-3.1.82/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
  7. tencentcloud_sdk_python_ess-3.1.81/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
  8. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/README.rst +0 -0
  9. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/setup.cfg +0 -0
  10. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud/ess/__init__.py +0 -0
  11. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud/ess/v20201111/__init__.py +0 -0
  12. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
  13. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud/ess/v20201111/ess_client.py +0 -0
  14. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud/ess/v20201111/ess_client_async.py +0 -0
  15. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_ess-3.1.81 → tencentcloud_sdk_python_ess-3.1.82}/tencentcloud_sdk_python_ess.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.81
3
+ Version: 3.1.82
4
4
  Summary: Tencent Cloud Ess SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.81
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.82
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-ess',
11
- install_requires=["tencentcloud-sdk-python-common>=3.1.81,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.82,<4.0.0"],
12
12
 
13
13
  version=tencentcloud.__version__,
14
14
  description='Tencent Cloud Ess SDK for Python',
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.81'
17
+ __version__ = '3.1.82'
@@ -391,170 +391,60 @@ class ApproverInfo(AbstractModel):
391
391
 
392
392
  def __init__(self):
393
393
  r"""
394
- :param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
395
- **0**:企业
396
- **1**:个人
397
- **3**:企业静默签署
398
- 注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
399
- **7**: 个人自动签署,适用于个人自动签场景。
400
- 注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
394
+ :param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:<br><strong>0</strong>:企业<br><strong>1</strong>:个人<br><strong>3</strong>:企业静默签署<br>注:<code>类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。</code><br><strong>7</strong>: 个人自动签署,适用于个人自动签场景。<br>注: <code>个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
401
395
  :type ApproverType: int
402
- :param _ApproverName: 签署方经办人的姓名。
403
- 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
396
+ :param _ApproverName: <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
404
397
  :type ApproverName: str
405
- :param _ApproverMobile: 签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)
406
- 请确认手机号所有方为此合同签署方。
398
+ :param _ApproverMobile: <p>签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。<br>请确认手机号所有方为此合同签署方。</p>
407
399
  :type ApproverMobile: str
408
- :param _OrganizationName: 组织机构名称。
409
- 请确认该名称与企业营业执照中注册的名称一致。
410
- 如果名称中包含英文括号(),请使用中文括号()代替。
411
- 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
412
-
400
+ :param _OrganizationName: <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。</p>
413
401
  :type OrganizationName: str
414
- :param _SignComponents: 【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
415
- <ul><li> 个人签名/印章</li>
416
- <li> 企业印章</li>
417
- <li> 骑缝章等签署控件</li></ul>
418
-
419
- ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)
402
+ :param _SignComponents: <p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li> 个人签名/印章</li><li> 企业印章</li><li> 骑缝章等签署控件</li></ul><p><img src="https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png" alt="image"></p>
420
403
  :type SignComponents: list of Component
421
- :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
422
- <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
423
- <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
424
- <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
425
- <li>OTHER_CARD_TYPE 其他证件</li></ul>
426
-
427
-
428
-
429
-
430
- 注:
431
- 1. <b>其他证件类型为白名单功能</b>,使用前请联系对接的客户经理沟通。
432
- 2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。
404
+ :param _ApproverIdCardType: <p>签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a></p><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li><li>OTHER_CARD_TYPE 其他证件</li></ul><p>注: </p><ol><li><b>其他证件类型为白名单功能</b>,使用前请联系对接的客户经理沟通。</li><li>港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。</li></ol>
433
405
  :type ApproverIdCardType: str
434
- :param _ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
435
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
436
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
437
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
406
+ :param _ApproverIdCardNumber: <p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
438
407
  :type ApproverIdCardNumber: str
439
- :param _NotifyType: 通知签署方经办人的方式, 有以下途径:
440
- <ul><li> **sms** : (默认)短信</li>
441
- <li> **none** : 不通知</li></ul>
442
-
443
- 注意:
444
- `如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信`
408
+ :param _NotifyType: <p>通知签署方经办人的方式, 有以下途径:</p><ul><li> **sms** : (默认)短信</li><li> **email** : 邮箱</li><li> **all** : 短信+邮箱</li><li> **none** : 不通知</li></ul><p>注意:<br><code>如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信</code></p><p>枚举值:</p><ul><li>sms: 短信通知</li><li>email: 邮件通知</li><li>all: 短信+邮件通知</li><li>none: 不做任何形式的通知</li></ul>
445
409
  :type NotifyType: str
446
- :param _ApproverRole: 收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
447
- <ul><li> **1** :收款人</li>
448
- <li> **2** :开具人</li>
449
- <li> **3** :见证人</li></ul>
450
- 注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
410
+ :param _ApproverRole: <p>收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:</p><ul><li> **1** :收款人</li><li> **2** :开具人</li><li> **3** :见证人</li></ul>注: <code>收据场景为白名单功能,使用前请联系对接的客户经理沟通。</code>
451
411
  :type ApproverRole: int
452
- :param _ApproverRoleName: 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
453
-
454
- 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
412
+ :param _ApproverRoleName: <p>可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。</p><p>注: <code>如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的</code></p>
455
413
  :type ApproverRoleName: str
456
- :param _VerifyChannel: <font color="red">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别
457
-
458
- 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
414
+ :param _VerifyChannel: <p><font color="red">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别</p><p>注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置</p>
459
415
  :type VerifyChannel: list of str
460
- :param _PreReadTime: 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
461
-
462
- 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
463
- <ul><li>合同页数少于等于2页,阅读时间为3秒;</li>
464
- <li>合同页数为3到5页,阅读时间为5秒;</li>
465
- <li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
416
+ :param _PreReadTime: <p>签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。</p><p>若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:</p><ul><li>合同页数少于等于2页,阅读时间为3秒;</li><li>合同页数为3到5页,阅读时间为5秒;</li><li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
466
417
  :type PreReadTime: int
467
- :param _UserId: 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
468
-
469
- 注:
470
- 如果传进来的<font color="red">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)
418
+ :param _UserId: <p>签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得</p><p>注:<br>如果传进来的<font color="red">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)</p>
471
419
  :type UserId: str
472
- :param _ApproverSource: 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
420
+ :param _ApproverSource: <p>在企微场景下使用,需设置参数为<strong>WEWORKAPP</strong>,以表明合同来源于企微。</p>
473
421
  :type ApproverSource: str
474
- :param _CustomApproverTag: 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
475
- 所有参与或签的人员均需具备该标识。
476
- 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
477
- 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
422
+ :param _CustomApproverTag: <p>在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。<br>所有参与或签的人员均需具备该标识。<br>注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。<br>如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。</p>
478
423
  :type CustomApproverTag: str
479
- :param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
480
- 详细操作可以参考开发者中心的ApproverOption结构体。
424
+ :param _ApproverOption: <p>可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。<br>详细操作可以参考开发者中心的ApproverOption结构体。</p>
481
425
  :type ApproverOption: :class:`tencentcloud.ess.v20201111.models.ApproverOption`
482
- :param _ApproverVerifyTypes: 【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】指定个人签署方查看合同的校验方式,可以传值如下:
483
- <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
484
- <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
485
- </li></ul>
486
- 注:
487
- <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
488
- <li>此字段可传多个校验方式</li></ul>
489
-
490
-
426
+ :param _ApproverVerifyTypes: <p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li><li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul>
491
427
  :type ApproverVerifyTypes: list of int
492
- :param _ApproverSignTypes: 【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】您可以指定签署方签署合同的认证校验方式,可传递以下值:
493
- <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
494
- <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
495
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li>
496
- <li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li>
497
- <li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul>
498
-
499
-
500
- 默认为:
501
- 1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
502
-
503
- 注:
504
- 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
505
- 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明
506
- 3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。
507
- 4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。
428
+ :param _ApproverSignTypes: <p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】您可以指定签署方签署合同的认证校验方式,可传递以下值:</p><ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li><li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li><li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li><li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li><li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul><p>默认为:<br>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/company/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>
508
429
  :type ApproverSignTypes: list of int
509
- :param _ApproverNeedSignReview: 此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:
510
- <ul><li>**false**:(默认)不需要审批,直接签署。</li>
511
- <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
512
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
513
- <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
514
- <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
515
-
516
- 注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`
517
-
518
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png)
430
+ :param _ApproverNeedSignReview: <p>此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:</p><ul><li>**false**:(默认)不需要审批,直接签署。</li><li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul><p>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
519
431
  :type ApproverNeedSignReview: bool
520
- :param _AddSignComponentsLimits: 【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。
521
-
522
- 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
432
+ :param _AddSignComponentsLimits: <p>【在用文件发起合同场景下才有效】在调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles">用PDF文件创建签署流程</a>创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。</p><p>注:<code>限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。</code></p>
523
433
  :type AddSignComponentsLimits: list of ComponentLimit
524
- :param _SignInstructionContent: 签署须知:支持传入富文本,最长字数:500个中文字符
434
+ :param _SignInstructionContent: <p>签署须知:支持传入富文本,最长字数:500个中文字符</p>
525
435
  :type SignInstructionContent: str
526
- :param _Deadline: 签署人的签署截止时间,格式为Unix标准时间戳(秒)
527
-
528
- 注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
436
+ :param _Deadline: <p>签署人的签署截止时间,格式为Unix标准时间戳(秒)</p><p>注: <code>若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同</code></p>
529
437
  :type Deadline: int
530
- :param _Components: 【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
531
- <ul><li>单行文本控件</li>
532
- <li>多行文本控件</li>
533
- <li>勾选框控件</li>
534
- <li>数字控件</li>
535
- <li>图片控件</li>
536
- </ul>
537
-
538
- 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件)
539
-
540
- 注:`此参数仅在通过文件发起合同或者合同组时生效`
541
-
542
- ![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
438
+ :param _Components: <p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li></ul><p>具体使用说明可参考<a href="https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件">为签署方指定填写控件</a></p><p>注:<code>此参数仅在通过文件发起合同或者合同组时生效</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
543
439
  :type Components: list of Component
544
- :param _SignEndpoints: 进入签署流程的限制,目前支持以下选项:
545
- <ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
440
+ :param _SignEndpoints: <p>进入签署流程的限制,目前支持以下选项:</p><ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
546
441
  :type SignEndpoints: list of str
547
- :param _RegisterInfo: 快速注册相关信息
548
-
442
+ :param _RegisterInfo: <p>快速注册相关信息</p>
549
443
  :type RegisterInfo: :class:`tencentcloud.ess.v20201111.models.RegisterInfo`
550
- :param _NotSaveContact: 是否不保存联系人
551
- 默认 false 保存联系人 true 不保存联系人
552
-
553
- 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。
554
- 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。
555
- 如下图位置:
556
- ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)
444
+ :param _NotSaveContact: <p>是否不保存联系人<br>默认 false 保存联系人 true 不保存联系人</p><p>设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。<br>联系人查看可登录<a href="https://test.qian.tencent.cn/console/">电子签控制台</a> 进行查看。<br>如下图位置:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png" alt=""></p>
557
445
  :type NotSaveContact: bool
446
+ :param _ApproverEmail: <p>客户指定的邮箱信息</p>
447
+ :type ApproverEmail: str
558
448
  """
559
449
  self._ApproverType = None
560
450
  self._ApproverName = None
@@ -582,16 +472,11 @@ class ApproverInfo(AbstractModel):
582
472
  self._SignEndpoints = None
583
473
  self._RegisterInfo = None
584
474
  self._NotSaveContact = None
475
+ self._ApproverEmail = None
585
476
 
586
477
  @property
587
478
  def ApproverType(self):
588
- r"""在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
589
- **0**:企业
590
- **1**:个人
591
- **3**:企业静默签署
592
- 注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
593
- **7**: 个人自动签署,适用于个人自动签场景。
594
- 注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
479
+ r"""<p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:<br><strong>0</strong>:企业<br><strong>1</strong>:个人<br><strong>3</strong>:企业静默签署<br>注:<code>类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。</code><br><strong>7</strong>: 个人自动签署,适用于个人自动签场景。<br>注: <code>个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
595
480
  :rtype: int
596
481
  """
597
482
  return self._ApproverType
@@ -602,8 +487,7 @@ class ApproverInfo(AbstractModel):
602
487
 
603
488
  @property
604
489
  def ApproverName(self):
605
- r"""签署方经办人的姓名。
606
- 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
490
+ r"""<p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
607
491
  :rtype: str
608
492
  """
609
493
  return self._ApproverName
@@ -614,8 +498,7 @@ class ApproverInfo(AbstractModel):
614
498
 
615
499
  @property
616
500
  def ApproverMobile(self):
617
- r"""签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)
618
- 请确认手机号所有方为此合同签署方。
501
+ r"""<p>签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。<br>请确认手机号所有方为此合同签署方。</p>
619
502
  :rtype: str
620
503
  """
621
504
  return self._ApproverMobile
@@ -626,11 +509,7 @@ class ApproverInfo(AbstractModel):
626
509
 
627
510
  @property
628
511
  def OrganizationName(self):
629
- r"""组织机构名称。
630
- 请确认该名称与企业营业执照中注册的名称一致。
631
- 如果名称中包含英文括号(),请使用中文括号()代替。
632
- 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
633
-
512
+ r"""<p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。</p>
634
513
  :rtype: str
635
514
  """
636
515
  return self._OrganizationName
@@ -641,12 +520,7 @@ class ApproverInfo(AbstractModel):
641
520
 
642
521
  @property
643
522
  def SignComponents(self):
644
- r"""【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
645
- <ul><li> 个人签名/印章</li>
646
- <li> 企业印章</li>
647
- <li> 骑缝章等签署控件</li></ul>
648
-
649
- ![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)
523
+ r"""<p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】合同中的该名签署方的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li> 个人签名/印章</li><li> 企业印章</li><li> 骑缝章等签署控件</li></ul><p><img src="https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png" alt="image"></p>
650
524
  :rtype: list of Component
651
525
  """
652
526
  return self._SignComponents
@@ -657,18 +531,7 @@ class ApproverInfo(AbstractModel):
657
531
 
658
532
  @property
659
533
  def ApproverIdCardType(self):
660
- r"""签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
661
- <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
662
- <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
663
- <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
664
- <li>OTHER_CARD_TYPE 其他证件</li></ul>
665
-
666
-
667
-
668
-
669
- 注:
670
- 1. <b>其他证件类型为白名单功能</b>,使用前请联系对接的客户经理沟通。
671
- 2. 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。
534
+ r"""<p>签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a></p><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li><li>OTHER_CARD_TYPE 其他证件</li></ul><p>注: </p><ol><li><b>其他证件类型为白名单功能</b>,使用前请联系对接的客户经理沟通。</li><li>港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。</li></ol>
672
535
  :rtype: str
673
536
  """
674
537
  return self._ApproverIdCardType
@@ -679,10 +542,7 @@ class ApproverInfo(AbstractModel):
679
542
 
680
543
  @property
681
544
  def ApproverIdCardNumber(self):
682
- r"""签署方经办人的证件号码,应符合以下规则
683
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
684
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
685
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
545
+ r"""<p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
686
546
  :rtype: str
687
547
  """
688
548
  return self._ApproverIdCardNumber
@@ -693,12 +553,7 @@ class ApproverInfo(AbstractModel):
693
553
 
694
554
  @property
695
555
  def NotifyType(self):
696
- r"""通知签署方经办人的方式, 有以下途径:
697
- <ul><li> **sms** : (默认)短信</li>
698
- <li> **none** : 不通知</li></ul>
699
-
700
- 注意:
701
- `如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信`
556
+ r"""<p>通知签署方经办人的方式, 有以下途径:</p><ul><li> **sms** : (默认)短信</li><li> **email** : 邮箱</li><li> **all** : 短信+邮箱</li><li> **none** : 不通知</li></ul><p>注意:<br><code>如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信</code></p><p>枚举值:</p><ul><li>sms: 短信通知</li><li>email: 邮件通知</li><li>all: 短信+邮件通知</li><li>none: 不做任何形式的通知</li></ul>
702
557
  :rtype: str
703
558
  """
704
559
  return self._NotifyType
@@ -709,11 +564,7 @@ class ApproverInfo(AbstractModel):
709
564
 
710
565
  @property
711
566
  def ApproverRole(self):
712
- r"""收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
713
- <ul><li> **1** :收款人</li>
714
- <li> **2** :开具人</li>
715
- <li> **3** :见证人</li></ul>
716
- 注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
567
+ r"""<p>收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:</p><ul><li> **1** :收款人</li><li> **2** :开具人</li><li> **3** :见证人</li></ul>注: <code>收据场景为白名单功能,使用前请联系对接的客户经理沟通。</code>
717
568
  :rtype: int
718
569
  """
719
570
  return self._ApproverRole
@@ -724,9 +575,7 @@ class ApproverInfo(AbstractModel):
724
575
 
725
576
  @property
726
577
  def ApproverRoleName(self):
727
- r"""可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
728
-
729
- 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
578
+ r"""<p>可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。</p><p>注: <code>如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的</code></p>
730
579
  :rtype: str
731
580
  """
732
581
  return self._ApproverRoleName
@@ -737,9 +586,7 @@ class ApproverInfo(AbstractModel):
737
586
 
738
587
  @property
739
588
  def VerifyChannel(self):
740
- r"""<font color="red">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别
741
-
742
- 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
589
+ r"""<p><font color="red">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别</p><p>注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置</p>
743
590
  :rtype: list of str
744
591
  """
745
592
  return self._VerifyChannel
@@ -750,12 +597,7 @@ class ApproverInfo(AbstractModel):
750
597
 
751
598
  @property
752
599
  def PreReadTime(self):
753
- r"""签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
754
-
755
- 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
756
- <ul><li>合同页数少于等于2页,阅读时间为3秒;</li>
757
- <li>合同页数为3到5页,阅读时间为5秒;</li>
758
- <li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
600
+ r"""<p>签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。</p><p>若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:</p><ul><li>合同页数少于等于2页,阅读时间为3秒;</li><li>合同页数为3到5页,阅读时间为5秒;</li><li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
759
601
  :rtype: int
760
602
  """
761
603
  return self._PreReadTime
@@ -766,10 +608,7 @@ class ApproverInfo(AbstractModel):
766
608
 
767
609
  @property
768
610
  def UserId(self):
769
- r"""签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
770
-
771
- 注:
772
- 如果传进来的<font color="red">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)
611
+ r"""<p>签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得</p><p>注:<br>如果传进来的<font color="red">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)</p>
773
612
  :rtype: str
774
613
  """
775
614
  return self._UserId
@@ -780,7 +619,7 @@ class ApproverInfo(AbstractModel):
780
619
 
781
620
  @property
782
621
  def ApproverSource(self):
783
- r"""在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
622
+ r"""<p>在企微场景下使用,需设置参数为<strong>WEWORKAPP</strong>,以表明合同来源于企微。</p>
784
623
  :rtype: str
785
624
  """
786
625
  return self._ApproverSource
@@ -791,10 +630,7 @@ class ApproverInfo(AbstractModel):
791
630
 
792
631
  @property
793
632
  def CustomApproverTag(self):
794
- r"""在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
795
- 所有参与或签的人员均需具备该标识。
796
- 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
797
- 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
633
+ r"""<p>在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。<br>所有参与或签的人员均需具备该标识。<br>注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。<br>如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。</p>
798
634
  :rtype: str
799
635
  """
800
636
  return self._CustomApproverTag
@@ -805,8 +641,7 @@ class ApproverInfo(AbstractModel):
805
641
 
806
642
  @property
807
643
  def ApproverOption(self):
808
- r"""可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
809
- 详细操作可以参考开发者中心的ApproverOption结构体。
644
+ r"""<p>可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。<br>详细操作可以参考开发者中心的ApproverOption结构体。</p>
810
645
  :rtype: :class:`tencentcloud.ess.v20201111.models.ApproverOption`
811
646
  """
812
647
  return self._ApproverOption
@@ -817,15 +652,7 @@ class ApproverInfo(AbstractModel):
817
652
 
818
653
  @property
819
654
  def ApproverVerifyTypes(self):
820
- r"""【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】指定个人签署方查看合同的校验方式,可以传值如下:
821
- <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
822
- <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
823
- </li></ul>
824
- 注:
825
- <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
826
- <li>此字段可传多个校验方式</li></ul>
827
-
828
-
655
+ r"""<p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li><li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul>
829
656
  :rtype: list of int
830
657
  """
831
658
  return self._ApproverVerifyTypes
@@ -836,22 +663,7 @@ class ApproverInfo(AbstractModel):
836
663
 
837
664
  @property
838
665
  def ApproverSignTypes(self):
839
- r"""【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】您可以指定签署方签署合同的认证校验方式,可传递以下值:
840
- <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
841
- <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
842
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li>
843
- <li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li>
844
- <li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul>
845
-
846
-
847
- 默认为:
848
- 1(人脸认证 ),2(签署密码),3(运营商三要素),5(设备指纹识别),6(设备面容识别)
849
-
850
- 注:
851
- 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
852
- 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明
853
- 3. 校验方式不允许只包含<font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>,至少需要再增加一种其他校验方式。
854
- 4. <font color='red'>设备指纹识别</font>和<font color='red'>设备面容识别</font>只支持小程序使用,其他端暂不支持。
666
+ r"""<p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】您可以指定签署方签署合同的认证校验方式,可传递以下值:</p><ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li><li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li><li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li><li>**5**:设备指纹识别,需要对比手机机主预留的指纹信息,校验一致才能成功进行合同签署。(iOS系统暂不支持该校验方式)</li><li>**6**:设备面容识别,需要对比手机机主预留的人脸信息,校验一致才能成功进行合同签署。(Android系统暂不支持该校验方式)</li></ul><p>默认为:<br>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/company/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>
855
667
  :rtype: list of int
856
668
  """
857
669
  return self._ApproverSignTypes
@@ -862,16 +674,7 @@ class ApproverInfo(AbstractModel):
862
674
 
863
675
  @property
864
676
  def ApproverNeedSignReview(self):
865
- r"""此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:
866
- <ul><li>**false**:(默认)不需要审批,直接签署。</li>
867
- <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
868
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
869
- <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
870
- <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
871
-
872
- 注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`
873
-
874
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png)
677
+ r"""<p>此签署人(员工或者个人)签署前,是否需要发起方企业审批,取值如下:</p><ul><li>**false**:(默认)不需要审批,直接签署。</li><li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul><p>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
875
678
  :rtype: bool
876
679
  """
877
680
  return self._ApproverNeedSignReview
@@ -882,9 +685,7 @@ class ApproverInfo(AbstractModel):
882
685
 
883
686
  @property
884
687
  def AddSignComponentsLimits(self):
885
- r"""【在用文件发起合同场景下才有效】在调用[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。
886
-
887
- 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
688
+ r"""<p>【在用文件发起合同场景下才有效】在调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles">用PDF文件创建签署流程</a>创建合同时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。</p><p>注:<code>限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。</code></p>
888
689
  :rtype: list of ComponentLimit
889
690
  """
890
691
  return self._AddSignComponentsLimits
@@ -895,7 +696,7 @@ class ApproverInfo(AbstractModel):
895
696
 
896
697
  @property
897
698
  def SignInstructionContent(self):
898
- r"""签署须知:支持传入富文本,最长字数:500个中文字符
699
+ r"""<p>签署须知:支持传入富文本,最长字数:500个中文字符</p>
899
700
  :rtype: str
900
701
  """
901
702
  return self._SignInstructionContent
@@ -906,9 +707,7 @@ class ApproverInfo(AbstractModel):
906
707
 
907
708
  @property
908
709
  def Deadline(self):
909
- r"""签署人的签署截止时间,格式为Unix标准时间戳(秒)
910
-
911
- 注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
710
+ r"""<p>签署人的签署截止时间,格式为Unix标准时间戳(秒)</p><p>注: <code>若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同</code></p>
912
711
  :rtype: int
913
712
  """
914
713
  return self._Deadline
@@ -919,19 +718,7 @@ class ApproverInfo(AbstractModel):
919
718
 
920
719
  @property
921
720
  def Components(self):
922
- r"""【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
923
- <ul><li>单行文本控件</li>
924
- <li>多行文本控件</li>
925
- <li>勾选框控件</li>
926
- <li>数字控件</li>
927
- <li>图片控件</li>
928
- </ul>
929
-
930
- 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件)
931
-
932
- 注:`此参数仅在通过文件发起合同或者合同组时生效`
933
-
934
- ![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
721
+ r"""<p>【在用文件发起合同场景下才有效,模板发起场景下需要在模板中配置】签署人在合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li></ul><p>具体使用说明可参考<a href="https://qian.tencent.cn/developers/company/createFlowByFiles/#指定签署方填写控件">为签署方指定填写控件</a></p><p>注:<code>此参数仅在通过文件发起合同或者合同组时生效</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
935
722
  :rtype: list of Component
936
723
  """
937
724
  return self._Components
@@ -942,8 +729,7 @@ class ApproverInfo(AbstractModel):
942
729
 
943
730
  @property
944
731
  def SignEndpoints(self):
945
- r"""进入签署流程的限制,目前支持以下选项:
946
- <ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
732
+ r"""<p>进入签署流程的限制,目前支持以下选项:</p><ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
947
733
  :rtype: list of str
948
734
  """
949
735
  return self._SignEndpoints
@@ -954,8 +740,7 @@ class ApproverInfo(AbstractModel):
954
740
 
955
741
  @property
956
742
  def RegisterInfo(self):
957
- r"""快速注册相关信息
958
-
743
+ r"""<p>快速注册相关信息</p>
959
744
  :rtype: :class:`tencentcloud.ess.v20201111.models.RegisterInfo`
960
745
  """
961
746
  return self._RegisterInfo
@@ -966,13 +751,7 @@ class ApproverInfo(AbstractModel):
966
751
 
967
752
  @property
968
753
  def NotSaveContact(self):
969
- r"""是否不保存联系人
970
- 默认 false 保存联系人 true 不保存联系人
971
-
972
- 设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。
973
- 联系人查看可登录[电子签控制台](https://test.qian.tencent.cn/console/) 进行查看。
974
- 如下图位置:
975
- ![](https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png)
754
+ r"""<p>是否不保存联系人<br>默认 false 保存联系人 true 不保存联系人</p><p>设置这个参数为保存联系人的时候,他方企业签署人会被保存进发起人的联系人中。<br>联系人查看可登录<a href="https://test.qian.tencent.cn/console/">电子签控制台</a> 进行查看。<br>如下图位置:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/fb8a22cd615d24c21acfa0e37e2cd873.png" alt=""></p>
976
755
  :rtype: bool
977
756
  """
978
757
  return self._NotSaveContact
@@ -981,6 +760,17 @@ class ApproverInfo(AbstractModel):
981
760
  def NotSaveContact(self, NotSaveContact):
982
761
  self._NotSaveContact = NotSaveContact
983
762
 
763
+ @property
764
+ def ApproverEmail(self):
765
+ r"""<p>客户指定的邮箱信息</p>
766
+ :rtype: str
767
+ """
768
+ return self._ApproverEmail
769
+
770
+ @ApproverEmail.setter
771
+ def ApproverEmail(self, ApproverEmail):
772
+ self._ApproverEmail = ApproverEmail
773
+
984
774
 
985
775
  def _deserialize(self, params):
986
776
  self._ApproverType = params.get("ApproverType")
@@ -1028,6 +818,7 @@ class ApproverInfo(AbstractModel):
1028
818
  self._RegisterInfo = RegisterInfo()
1029
819
  self._RegisterInfo._deserialize(params.get("RegisterInfo"))
1030
820
  self._NotSaveContact = params.get("NotSaveContact")
821
+ self._ApproverEmail = params.get("ApproverEmail")
1031
822
  memeber_set = set(params.keys())
1032
823
  for name, value in vars(self).items():
1033
824
  property_name = name[1:]
@@ -12311,23 +12102,26 @@ class CreateFlowRemindsRequest(AbstractModel):
12311
12102
 
12312
12103
  def __init__(self):
12313
12104
  r"""
12314
- :param _Operator: 执行本接口操作的员工信息。
12315
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
12105
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
12316
12106
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
12317
- :param _FlowIds: 需执行催办的签署流程ID数组,最多包含100个。
12107
+ :param _FlowIds: <p>需执行催办的签署流程ID数组,最多包含100个。</p>
12318
12108
  :type FlowIds: list of str
12319
- :param _Agent: 代理企业和员工的信息。
12320
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12109
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
12321
12110
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
12111
+ :param _RemindTypes: <p>指定通知方式,枚举值:SMS / EMAIL;为空则按签署人原始 NotifyType 处理</p>
12112
+ :type RemindTypes: list of str
12113
+ :param _RemindEmailInfos: <p>邮箱覆盖列表,为指定签署人使用特定邮箱发送邮件催办</p>
12114
+ :type RemindEmailInfos: list of RemindEmailInfo
12322
12115
  """
12323
12116
  self._Operator = None
12324
12117
  self._FlowIds = None
12325
12118
  self._Agent = None
12119
+ self._RemindTypes = None
12120
+ self._RemindEmailInfos = None
12326
12121
 
12327
12122
  @property
12328
12123
  def Operator(self):
12329
- r"""执行本接口操作的员工信息。
12330
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
12124
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
12331
12125
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
12332
12126
  """
12333
12127
  return self._Operator
@@ -12338,7 +12132,7 @@ class CreateFlowRemindsRequest(AbstractModel):
12338
12132
 
12339
12133
  @property
12340
12134
  def FlowIds(self):
12341
- r"""需执行催办的签署流程ID数组,最多包含100个。
12135
+ r"""<p>需执行催办的签署流程ID数组,最多包含100个。</p>
12342
12136
  :rtype: list of str
12343
12137
  """
12344
12138
  return self._FlowIds
@@ -12349,8 +12143,7 @@ class CreateFlowRemindsRequest(AbstractModel):
12349
12143
 
12350
12144
  @property
12351
12145
  def Agent(self):
12352
- r"""代理企业和员工的信息。
12353
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12146
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
12354
12147
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
12355
12148
  """
12356
12149
  return self._Agent
@@ -12359,6 +12152,28 @@ class CreateFlowRemindsRequest(AbstractModel):
12359
12152
  def Agent(self, Agent):
12360
12153
  self._Agent = Agent
12361
12154
 
12155
+ @property
12156
+ def RemindTypes(self):
12157
+ r"""<p>指定通知方式,枚举值:SMS / EMAIL;为空则按签署人原始 NotifyType 处理</p>
12158
+ :rtype: list of str
12159
+ """
12160
+ return self._RemindTypes
12161
+
12162
+ @RemindTypes.setter
12163
+ def RemindTypes(self, RemindTypes):
12164
+ self._RemindTypes = RemindTypes
12165
+
12166
+ @property
12167
+ def RemindEmailInfos(self):
12168
+ r"""<p>邮箱覆盖列表,为指定签署人使用特定邮箱发送邮件催办</p>
12169
+ :rtype: list of RemindEmailInfo
12170
+ """
12171
+ return self._RemindEmailInfos
12172
+
12173
+ @RemindEmailInfos.setter
12174
+ def RemindEmailInfos(self, RemindEmailInfos):
12175
+ self._RemindEmailInfos = RemindEmailInfos
12176
+
12362
12177
 
12363
12178
  def _deserialize(self, params):
12364
12179
  if params.get("Operator") is not None:
@@ -12368,6 +12183,13 @@ class CreateFlowRemindsRequest(AbstractModel):
12368
12183
  if params.get("Agent") is not None:
12369
12184
  self._Agent = Agent()
12370
12185
  self._Agent._deserialize(params.get("Agent"))
12186
+ self._RemindTypes = params.get("RemindTypes")
12187
+ if params.get("RemindEmailInfos") is not None:
12188
+ self._RemindEmailInfos = []
12189
+ for item in params.get("RemindEmailInfos"):
12190
+ obj = RemindEmailInfo()
12191
+ obj._deserialize(item)
12192
+ self._RemindEmailInfos.append(obj)
12371
12193
  memeber_set = set(params.keys())
12372
12194
  for name, value in vars(self).items():
12373
12195
  property_name = name[1:]
@@ -12385,7 +12207,7 @@ class CreateFlowRemindsResponse(AbstractModel):
12385
12207
 
12386
12208
  def __init__(self):
12387
12209
  r"""
12388
- :param _RemindFlowRecords: 合同催办结果的详细信息列表。
12210
+ :param _RemindFlowRecords: <p>合同催办结果的详细信息列表。</p>
12389
12211
  :type RemindFlowRecords: list of RemindFlowRecords
12390
12212
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12391
12213
  :type RequestId: str
@@ -12395,7 +12217,7 @@ class CreateFlowRemindsResponse(AbstractModel):
12395
12217
 
12396
12218
  @property
12397
12219
  def RemindFlowRecords(self):
12398
- r"""合同催办结果的详细信息列表。
12220
+ r"""<p>合同催办结果的详细信息列表。</p>
12399
12221
  :rtype: list of RemindFlowRecords
12400
12222
  """
12401
12223
  return self._RemindFlowRecords
@@ -42549,6 +42371,57 @@ class RelieveInfo(AbstractModel):
42549
42371
 
42550
42372
 
42551
42373
 
42374
+ class RemindEmailInfo(AbstractModel):
42375
+ r"""催办邮件结构体
42376
+
42377
+ """
42378
+
42379
+ def __init__(self):
42380
+ r"""
42381
+ :param _SignId: <p>签署编号</p>
42382
+ :type SignId: str
42383
+ :param _ApproverEmail: <p>指定邮箱地址,催办时使用此邮箱替代 DB 中存储的邮箱</p>
42384
+ :type ApproverEmail: str
42385
+ """
42386
+ self._SignId = None
42387
+ self._ApproverEmail = None
42388
+
42389
+ @property
42390
+ def SignId(self):
42391
+ r"""<p>签署编号</p>
42392
+ :rtype: str
42393
+ """
42394
+ return self._SignId
42395
+
42396
+ @SignId.setter
42397
+ def SignId(self, SignId):
42398
+ self._SignId = SignId
42399
+
42400
+ @property
42401
+ def ApproverEmail(self):
42402
+ r"""<p>指定邮箱地址,催办时使用此邮箱替代 DB 中存储的邮箱</p>
42403
+ :rtype: str
42404
+ """
42405
+ return self._ApproverEmail
42406
+
42407
+ @ApproverEmail.setter
42408
+ def ApproverEmail(self, ApproverEmail):
42409
+ self._ApproverEmail = ApproverEmail
42410
+
42411
+
42412
+ def _deserialize(self, params):
42413
+ self._SignId = params.get("SignId")
42414
+ self._ApproverEmail = params.get("ApproverEmail")
42415
+ memeber_set = set(params.keys())
42416
+ for name, value in vars(self).items():
42417
+ property_name = name[1:]
42418
+ if property_name in memeber_set:
42419
+ memeber_set.remove(property_name)
42420
+ if len(memeber_set) > 0:
42421
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
42422
+
42423
+
42424
+
42552
42425
  class RemindFlowRecords(AbstractModel):
42553
42426
  r"""催办接口返回的详细信息。
42554
42427
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.81
3
+ Version: 3.1.82
4
4
  Summary: Tencent Cloud Ess SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.81
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.82
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.82
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.81