tencentcloud-sdk-python-ess 3.0.1117__tar.gz → 3.0.1122__tar.gz

{tencentcloud-sdk-python-ess-3.0.1117 → tencentcloud-sdk-python-ess-3.0.1122}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.0.1117
+Version: 3.0.1122
 Summary: Tencent Cloud Ess SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

{tencentcloud-sdk-python-ess-3.0.1117 → tencentcloud-sdk-python-ess-3.0.1122}/setup.py

@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
 
 setup(
     name='tencentcloud-sdk-python-ess',
-    install_requires=["tencentcloud-sdk-python-common==3.0.1117"],
+    install_requires=["tencentcloud-sdk-python-common==3.0.1122"],
     version=tencentcloud.__version__,
     description='Tencent Cloud Ess SDK for Python',
     long_description=open('README.rst').read(),

{tencentcloud-sdk-python-ess-3.0.1117 → tencentcloud-sdk-python-ess-3.0.1122}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1117'
+__version__ = '3.0.1122'

{tencentcloud-sdk-python-ess-3.0.1117 → tencentcloud-sdk-python-ess-3.0.1122}/tencentcloud/ess/v20201111/models.py

@@ -303,9 +303,10 @@ class ApproverInfo(AbstractModel):
 <li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li>
 <li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。</li></ul>
 
+默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
+
 注：
-1. 默认情况下，认证校验方式为人脸认证和签署密码两种形式
-2. 您可以传递多种值，表示可用多种认证校验方式
+1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
 3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明
         :type ApproverSignTypes: list of int
         :param _ApproverNeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
@@ -681,8 +682,10 @@ class ApproverOption(AbstractModel):
         :type CanEditApprover: bool
         :param _FillType: 签署人信息补充类型，默认无需补充。
 
-<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li>
-</ul>
+<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
+
+注：
+`使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
         :type FillType: int
         :param _FlowReadLimit: 签署人阅读合同限制参数
  <br/>取值：
@@ -2017,15 +2020,13 @@ class Component(AbstractModel):
 <ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
 <li> <b>SIGN_DATE</b> : 签署日期控件；</li>
 <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
-<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件（使用文件发起暂不支持此类型）；</li>
 <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
 <li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
 <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
 
 * 个人方
 <ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>
-<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
-<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件（使用文件发起暂不支持此类型）；</li></ul>
+<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li></ul>
  
 注：` 表单域的控件不能作为印章和签名控件`
         :type ComponentType: str
@@ -5063,10 +5064,10 @@ class CreateFlowOption(AbstractModel):
         :type CustomCreateFlowDescription: str
         :param _ForbidAddApprover:   禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”
 
-        :type ForbidAddApprover: str
+        :type ForbidAddApprover: bool
         :param _ForbidEditFlowProperties:   禁止设置设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
 
-        :type ForbidEditFlowProperties: str
+        :type ForbidEditFlowProperties: bool
         :param _HideComponentTypes: 在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用，具体的控件类型如下
 <ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
 <li>SIGN_SEAL : 企业印章</li>
@@ -8263,8 +8264,9 @@ class CreateSchemeUrlRequest(AbstractModel):
 <ul><li>**false**：否, 签署完成不会自动跳转回来(默认)</li><li>**true**：是, 签署完成会自动跳转回来</li></ul>
 
 注: 
-1. 该参数<font color="red">只针对APP</font> 类型的签署链接有效
+1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
+3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font> 
         :type AutoJumpBack: bool
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -14672,13 +14674,12 @@ class FlowCreateApprover(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _ApproverType: 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
-0：企业
-1：个人
-3：企业静默签署
-注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
-7: 个人自动签署，适用于个人自动签场景。
-注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
+        :param _ApproverType: 在指定签署方时，可以选择企业B端或个人C端等不同的参与者类型，可选类型如下：
+
+<ul><li> <b>0</b> :企业B端。</li>
+<li> <b>1</b> :个人C端。</li>
+<li> <b>3</b> :企业B端静默（自动）签署，无需签署人参与，自动签署可以参考<a href="https://qian.tencent.com/developers/company/autosign_guide" target="_blank" rel="noopener noreferrer">自动签署使用说明</a>文档。</li>
+<li> <b>7</b> :个人C端自动签署，适用于个人自动签场景。注: <b>个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。</b> </li></ul>
         :type ApproverType: int
         :param _OrganizationName: 组织机构名称。
 请确认该名称与企业营业执照中注册的名称一致。
@@ -14693,16 +14694,15 @@ class FlowCreateApprover(AbstractModel):
 
 在未指定签署人电子签UserId情况下，为必填参数
         :type ApproverName: str
-        :param _ApproverMobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
-请确认手机号所有方为此合同签署方。
+        :param _ApproverMobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
 
-在未指定签署人电子签UserId情况下，为必填参数
+注：`在未指定签署人电子签UserId情况下，为必填参数`
 
         :type ApproverMobile: str
         :param _ApproverIdCardType: 证件类型，支持以下类型
-<ul><li>ID_CARD : 居民身份证 (默认值)</li>
-<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
-<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
+<ul><li><b>ID_CARD</b>: 居民身份证 (默认值)</li>
+<li><b>HONGKONG_AND_MACAO</b> : 港澳居民来往内地通行证</li>
+<li><b>HONGKONG_MACAO_AND_TAIWAN</b> : 港澳台居民居住证(格式同居民身份证)</li></ul>
         :type ApproverIdCardType: str
         :param _ApproverIdCardNumber: 证件号码，应符合以下规则
 <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
@@ -14710,29 +14710,39 @@ class FlowCreateApprover(AbstractModel):
 <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
         :type ApproverIdCardNumber: str
         :param _RecipientId: 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
-模板发起合同时，该参数为必填项。
-文件发起合同时，该参数无需传值。
+
+<b>模板发起合同时，该参数为必填项，可以通过[查询模版信息接口](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates)获得。</b>
+<b>文件发起合同时，该参数无需传值。</b>
+
 如果开发者后续用合同模板发起合同，建议保存此值，在用合同模板发起合同中需此值绑定对应的签署经办人 。
         :type RecipientId: str
         :param _VerifyChannel: 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
 
-注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
+注: <font color="red">将要废弃</font >, `用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置`
         :type VerifyChannel: list of str
         :param _NotifyType: 通知签署方经办人的方式,  有以下途径:
 <ul><li>  **sms**  :  (默认)短信</li>
 <li>   **none**   : 不通知</li></ul>
 
-注: `发起方也是签署方时不给此签署方发送短信`
+注: `既是发起方又是签署方时，不给此签署方发送短信`
         :type NotifyType: str
         :param _IsFullText: 合同强制需要阅读全文，无需传此参数
         :type IsFullText: bool
-        :param _PreReadTime: 合同的强制预览时间：3~300s，未指定则按合同页数计算
+        :param _PreReadTime: 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
+
+若未指定阅读时间，则会按照合同页数大小计算阅读时间，计算规则如下：
+<ul>
+<li>合同页数少于等于2页，阅读时间为3秒；</li>
+<li>合同页数为3到5页，阅读时间为5秒；</li>
+<li>合同页数大于等于6页，阅读时间为10秒。</li>
+</ul>
         :type PreReadTime: int
         :param _UserId: 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
 
-注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
+注： 
+如果传进来的<font color="red">UserId已经实名， 则忽略ApproverName，ApproverIdCardType，ApproverIdCardNumber，ApproverMobile这四个入参</font>（会用此UserId实名的身份证和登录的手机号覆盖）
         :type UserId: str
-        :param _Required: 字段已经废弃，当前只支持true，默认为true
+        :param _Required: <font color="red">字段已经废弃</font>，当前只支持true，默认为true
         :type Required: bool
         :param _ApproverSource: 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
         :type ApproverSource: str
@@ -14747,9 +14757,12 @@ class FlowCreateApprover(AbstractModel):
         :type ApproverOption: :class:`tencentcloud.ess.v20201111.models.ApproverOption`
         :param _JumpUrl: 签署完前端跳转的url，暂未使用
         :type JumpUrl: str
-        :param _SignId: 签署ID
-- 发起流程时系统自动补充
-- 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
+        :param _SignId: 签署人的签署ID
+
+<ul>
+<li>在CreateFlow、CreatePrepareFlow等发起流程时不需要传入此参数，电子签后台系统会自动生成。</li>
+<li>在CreateFlowSignUrl、CreateBatchQuickSignUrl等生成签署链接时，可以通过查询详情接口获取签署人的SignId，然后可以将此值传入，为该签署人创建签署链接。这样可以避免重复传输姓名、手机号、证件号等其他信息。</li>
+</ul>
         :type SignId: str
         :param _ApproverNeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
 <ul><li>**false**：（默认）不需要审批，直接签署。</li>
@@ -14781,11 +14794,16 @@ class FlowCreateApprover(AbstractModel):
 
 `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
         :type Components: list of Component
-        :param _ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式
-	HANDWRITE – 手写签名
-	OCR_ESIGN -- AI智能识别手写签名
-	ESIGN -- 个人印章类型
-	SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
+        :param _ComponentLimitType: 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
+
+<ul><li> <b>HANDWRITE</b> :手写签名。</li>
+<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
+<li> <b>ESIGN</b> :个人印章类型。</li>
+<li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
+<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
+
+各种签名的样式可以参考下图：
+![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
         :type ComponentLimitType: list of str
         :param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
 <ul><li>  **1**   : （默认）人脸识别,人脸识别后才能合同内容</li>
@@ -14816,8 +14834,7 @@ class FlowCreateApprover(AbstractModel):
 注：
 `不指定该值时，默认为签署方自行选择。`
         :type SignTypeSelector: int
-        :param _Deadline: Deadline
-签署人的签署截止时间，格式为Unix标准时间戳（秒）
+        :param _Deadline: 签署人的签署截止时间，格式为Unix标准时间戳（秒）, 超过此时间未签署的合同变成已过期状态，不能在继续签署
 
 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
         :type Deadline: int

{tencentcloud-sdk-python-ess-3.0.1117 → tencentcloud-sdk-python-ess-3.0.1122}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.0.1117
+Version: 3.0.1122
 Summary: Tencent Cloud Ess SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

tencentcloud-sdk-python-ess-3.0.1122/tencentcloud_sdk_python_ess.egg-info/requires.txt

@@ -0,0 +1 @@
+tencentcloud-sdk-python-common==3.0.1122

tencentcloud-sdk-python-ess-3.0.1117/tencentcloud_sdk_python_ess.egg-info/requires.txt

@@ -1 +0,0 @@
-tencentcloud-sdk-python-common==3.0.1117