tencentcloud-sdk-python-ess 3.1.187__tar.gz → 3.1.191__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.187 → tencentcloud_sdk_python_ess-3.1.191}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/setup.py +1 -1
  3. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud/ess/v20201111/models.py +51 -122
  5. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
  6. tencentcloud_sdk_python_ess-3.1.191/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
  7. tencentcloud_sdk_python_ess-3.1.187/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
  8. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/README.rst +0 -0
  9. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/setup.cfg +0 -0
  10. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud/ess/__init__.py +0 -0
  11. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud/ess/v20201111/__init__.py +0 -0
  12. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
  13. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud/ess/v20201111/ess_client.py +0 -0
  14. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud/ess/v20201111/ess_client_async.py +0 -0
  15. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_ess-3.1.187 → tencentcloud_sdk_python_ess-3.1.191}/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.187
3
+ Version: 3.1.191
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.187
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.191
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.187,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.191,<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.187'
17
+ __version__ = '3.1.191'
@@ -247,8 +247,6 @@ class Agent(AbstractModel):
247
247
 
248
248
  @property
249
249
  def AppId(self):
250
- warnings.warn("parameter `AppId` is deprecated", DeprecationWarning)
251
-
252
250
  r"""<p>CA-API应用编号,用于同平台企业下标识不同的CA-API应用</p>
253
251
  :rtype: str
254
252
  """
@@ -256,8 +254,6 @@ class Agent(AbstractModel):
256
254
 
257
255
  @AppId.setter
258
256
  def AppId(self, AppId):
259
- warnings.warn("parameter `AppId` is deprecated", DeprecationWarning)
260
-
261
257
  self._AppId = AppId
262
258
 
263
259
  @property
@@ -8533,26 +8529,29 @@ class CreateDraftContractByPromptsTaskRequest(AbstractModel):
8533
8529
 
8534
8530
  def __init__(self):
8535
8531
  r"""
8536
- :param _Operator: 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
8532
+ :param _Operator: <p>执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</p>
8537
8533
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
8538
- :param _Requirement: 起草要求,范围要求 5-1000 字
8534
+ :param _Requirement: <p>起草要求,范围要求 5-1000 字</p>
8539
8535
  :type Requirement: str
8540
- :param _ReferenceTemplateId: 参考模板文件资源id(PDF/Word格式),大小不超过1M,通过[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口来获取。
8536
+ :param _ReferenceTemplateId: <p>参考模板文件资源id(PDF/Word格式),大小不超过1M,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">上传文件</a>接口来获取。</p>
8541
8537
  :type ReferenceTemplateId: str
8542
- :param _RequirementFileIds: 相关规定文件资源id列表(PDF/Word格式),最多3个文件,每个大小不超过1M,通过[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口来获取。
8538
+ :param _RequirementFileIds: <p>相关规定文件资源id列表(PDF/Word格式),最多3个文件,每个大小不超过1M,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">上传文件</a>接口来获取。</p>
8543
8539
  :type RequirementFileIds: list of str
8544
- :param _ContractLanguage: 起草合同的语言要求(zh,en)默认zh
8540
+ :param _ContractLanguage: <p>起草合同的语言要求(zh,en)默认zh</p>
8545
8541
  :type ContractLanguage: str
8542
+ :param _ReviewTaskId: <p>审查任务id,仅支持传入1个,通过<a href="https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/CreateBatchContractReviewTask/">批量创建合同审查任务</a>接口来获取。</p>
8543
+ :type ReviewTaskId: str
8546
8544
  """
8547
8545
  self._Operator = None
8548
8546
  self._Requirement = None
8549
8547
  self._ReferenceTemplateId = None
8550
8548
  self._RequirementFileIds = None
8551
8549
  self._ContractLanguage = None
8550
+ self._ReviewTaskId = None
8552
8551
 
8553
8552
  @property
8554
8553
  def Operator(self):
8555
- r"""执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
8554
+ r"""<p>执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</p>
8556
8555
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
8557
8556
  """
8558
8557
  return self._Operator
@@ -8563,7 +8562,7 @@ class CreateDraftContractByPromptsTaskRequest(AbstractModel):
8563
8562
 
8564
8563
  @property
8565
8564
  def Requirement(self):
8566
- r"""起草要求,范围要求 5-1000 字
8565
+ r"""<p>起草要求,范围要求 5-1000 字</p>
8567
8566
  :rtype: str
8568
8567
  """
8569
8568
  return self._Requirement
@@ -8574,7 +8573,7 @@ class CreateDraftContractByPromptsTaskRequest(AbstractModel):
8574
8573
 
8575
8574
  @property
8576
8575
  def ReferenceTemplateId(self):
8577
- r"""参考模板文件资源id(PDF/Word格式),大小不超过1M,通过[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口来获取。
8576
+ r"""<p>参考模板文件资源id(PDF/Word格式),大小不超过1M,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">上传文件</a>接口来获取。</p>
8578
8577
  :rtype: str
8579
8578
  """
8580
8579
  return self._ReferenceTemplateId
@@ -8585,7 +8584,7 @@ class CreateDraftContractByPromptsTaskRequest(AbstractModel):
8585
8584
 
8586
8585
  @property
8587
8586
  def RequirementFileIds(self):
8588
- r"""相关规定文件资源id列表(PDF/Word格式),最多3个文件,每个大小不超过1M,通过[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口来获取。
8587
+ r"""<p>相关规定文件资源id列表(PDF/Word格式),最多3个文件,每个大小不超过1M,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">上传文件</a>接口来获取。</p>
8589
8588
  :rtype: list of str
8590
8589
  """
8591
8590
  return self._RequirementFileIds
@@ -8596,7 +8595,7 @@ class CreateDraftContractByPromptsTaskRequest(AbstractModel):
8596
8595
 
8597
8596
  @property
8598
8597
  def ContractLanguage(self):
8599
- r"""起草合同的语言要求(zh,en)默认zh
8598
+ r"""<p>起草合同的语言要求(zh,en)默认zh</p>
8600
8599
  :rtype: str
8601
8600
  """
8602
8601
  return self._ContractLanguage
@@ -8605,6 +8604,17 @@ class CreateDraftContractByPromptsTaskRequest(AbstractModel):
8605
8604
  def ContractLanguage(self, ContractLanguage):
8606
8605
  self._ContractLanguage = ContractLanguage
8607
8606
 
8607
+ @property
8608
+ def ReviewTaskId(self):
8609
+ r"""<p>审查任务id,仅支持传入1个,通过<a href="https://qian.tencent.com/developers/companyApis/%E5%90%88%E5%90%8C%E6%99%BA%E8%83%BD%E7%9B%B8%E5%85%B3%E6%8E%A5%E5%8F%A3/CreateBatchContractReviewTask/">批量创建合同审查任务</a>接口来获取。</p>
8610
+ :rtype: str
8611
+ """
8612
+ return self._ReviewTaskId
8613
+
8614
+ @ReviewTaskId.setter
8615
+ def ReviewTaskId(self, ReviewTaskId):
8616
+ self._ReviewTaskId = ReviewTaskId
8617
+
8608
8618
 
8609
8619
  def _deserialize(self, params):
8610
8620
  if params.get("Operator") is not None:
@@ -8614,6 +8624,7 @@ class CreateDraftContractByPromptsTaskRequest(AbstractModel):
8614
8624
  self._ReferenceTemplateId = params.get("ReferenceTemplateId")
8615
8625
  self._RequirementFileIds = params.get("RequirementFileIds")
8616
8626
  self._ContractLanguage = params.get("ContractLanguage")
8627
+ self._ReviewTaskId = params.get("ReviewTaskId")
8617
8628
  memeber_set = set(params.keys())
8618
8629
  for name, value in vars(self).items():
8619
8630
  property_name = name[1:]
@@ -8631,7 +8642,7 @@ class CreateDraftContractByPromptsTaskResponse(AbstractModel):
8631
8642
 
8632
8643
  def __init__(self):
8633
8644
  r"""
8634
- :param _TaskId: 起草任务id
8645
+ :param _TaskId: <p>起草任务id</p>
8635
8646
  注意:此字段可能返回 null,表示取不到有效值。
8636
8647
  :type TaskId: str
8637
8648
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -8642,7 +8653,7 @@ class CreateDraftContractByPromptsTaskResponse(AbstractModel):
8642
8653
 
8643
8654
  @property
8644
8655
  def TaskId(self):
8645
- r"""起草任务id
8656
+ r"""<p>起草任务id</p>
8646
8657
  注意:此字段可能返回 null,表示取不到有效值。
8647
8658
  :rtype: str
8648
8659
  """
@@ -20906,44 +20917,23 @@ class CreateUserVerifyUrlRequest(AbstractModel):
20906
20917
 
20907
20918
  def __init__(self):
20908
20919
  r"""
20909
- :param _Operator: 操作人信息
20920
+ :param _Operator: <p>操作人信息</p>
20910
20921
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
20911
- :param _Name: 要实名的姓名
20922
+ :param _Name: <p>要实名的姓名</p>
20912
20923
  :type Name: str
20913
- :param _IdCardNumber: 要实名的身份证号码,
20914
- 身份证号码如果有x的话,统一传大写X
20924
+ :param _IdCardNumber: <p>要实名的身份证号码,<br>身份证号码如果有x的话,统一传大写X</p>
20915
20925
  :type IdCardNumber: str
20916
- :param _IdCardType: 证件类型,目前只支持身份证类型:ID_CARD
20926
+ :param _IdCardType: <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></ul><p>注: 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。</p>
20917
20927
  :type IdCardType: str
20918
- :param _Mobile: 要实名的手机号,兼容带+86的格式
20928
+ :param _Mobile: <p>要实名的手机号,兼容带+86的格式</p>
20919
20929
  :type Mobile: str
20920
- :param _JumpUrl: 实名完之后的跳转链接,最大长度1000个字符。
20921
- 链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。
20922
-
20923
- 注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递
20924
-
20930
+ :param _JumpUrl: <p>实名完之后的跳转链接,最大长度1000个字符。<br>链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。</p><p>注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递</p>
20925
20931
  :type JumpUrl: str
20926
- :param _Endpoint: 要跳转的链接类型
20927
-
20928
- <ul>
20929
- <li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
20930
- <li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
20931
- <li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>
20932
- <li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li>
20933
- <li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li>
20934
- </ul>
20935
-
20936
- 注:如果不传递,默认值是 <font color="red"> APP </font>
20932
+ :param _Endpoint: <p>要跳转的链接类型</p><ul><li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li><li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li><li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li><li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li><li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li></ul><p>注:如果不传递,默认值是 <font color="red"> APP </font></p>
20937
20933
  :type Endpoint: str
20938
- :param _AutoJumpBack: 签署完成后是否自动回跳
20939
- <ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>
20940
-
20941
- 注:
20942
- 1. 该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效
20943
- 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
20944
- 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
20934
+ :param _AutoJumpBack: <p>签署完成后是否自动回跳</p><ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font></li></ol>
20945
20935
  :type AutoJumpBack: bool
20946
- :param _UserData: 在用户完成实名认证后,其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。
20936
+ :param _UserData: <p>在用户完成实名认证后,其自定义数据将通过<a href="https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83">企业引导个人实名认证后回调</a>返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。</p>
20947
20937
  :type UserData: str
20948
20938
  """
20949
20939
  self._Operator = None
@@ -20958,7 +20948,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
20958
20948
 
20959
20949
  @property
20960
20950
  def Operator(self):
20961
- r"""操作人信息
20951
+ r"""<p>操作人信息</p>
20962
20952
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
20963
20953
  """
20964
20954
  return self._Operator
@@ -20969,7 +20959,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
20969
20959
 
20970
20960
  @property
20971
20961
  def Name(self):
20972
- r"""要实名的姓名
20962
+ r"""<p>要实名的姓名</p>
20973
20963
  :rtype: str
20974
20964
  """
20975
20965
  return self._Name
@@ -20980,8 +20970,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
20980
20970
 
20981
20971
  @property
20982
20972
  def IdCardNumber(self):
20983
- r"""要实名的身份证号码,
20984
- 身份证号码如果有x的话,统一传大写X
20973
+ r"""<p>要实名的身份证号码,<br>身份证号码如果有x的话,统一传大写X</p>
20985
20974
  :rtype: str
20986
20975
  """
20987
20976
  return self._IdCardNumber
@@ -20992,7 +20981,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
20992
20981
 
20993
20982
  @property
20994
20983
  def IdCardType(self):
20995
- r"""证件类型,目前只支持身份证类型:ID_CARD
20984
+ 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></ul><p>注: 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。</p>
20996
20985
  :rtype: str
20997
20986
  """
20998
20987
  return self._IdCardType
@@ -21003,7 +20992,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
21003
20992
 
21004
20993
  @property
21005
20994
  def Mobile(self):
21006
- r"""要实名的手机号,兼容带+86的格式
20995
+ r"""<p>要实名的手机号,兼容带+86的格式</p>
21007
20996
  :rtype: str
21008
20997
  """
21009
20998
  return self._Mobile
@@ -21014,11 +21003,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
21014
21003
 
21015
21004
  @property
21016
21005
  def JumpUrl(self):
21017
- r"""实名完之后的跳转链接,最大长度1000个字符。
21018
- 链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。
21019
-
21020
- 注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递
21021
-
21006
+ r"""<p>实名完之后的跳转链接,最大长度1000个字符。<br>链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。</p><p>注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递</p>
21022
21007
  :rtype: str
21023
21008
  """
21024
21009
  return self._JumpUrl
@@ -21029,17 +21014,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
21029
21014
 
21030
21015
  @property
21031
21016
  def Endpoint(self):
21032
- r"""要跳转的链接类型
21033
-
21034
- <ul>
21035
- <li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
21036
- <li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
21037
- <li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>
21038
- <li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li>
21039
- <li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li>
21040
- </ul>
21041
-
21042
- 注:如果不传递,默认值是 <font color="red"> APP </font>
21017
+ r"""<p>要跳转的链接类型</p><ul><li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li><li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li><li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li><li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li><li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li></ul><p>注:如果不传递,默认值是 <font color="red"> APP </font></p>
21043
21018
  :rtype: str
21044
21019
  """
21045
21020
  return self._Endpoint
@@ -21050,13 +21025,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
21050
21025
 
21051
21026
  @property
21052
21027
  def AutoJumpBack(self):
21053
- r"""签署完成后是否自动回跳
21054
- <ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>
21055
-
21056
- 注:
21057
- 1. 该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效
21058
- 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
21059
- 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
21028
+ r"""<p>签署完成后是否自动回跳</p><ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font></li></ol>
21060
21029
  :rtype: bool
21061
21030
  """
21062
21031
  return self._AutoJumpBack
@@ -21067,7 +21036,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
21067
21036
 
21068
21037
  @property
21069
21038
  def UserData(self):
21070
- r"""在用户完成实名认证后,其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。
21039
+ r"""<p>在用户完成实名认证后,其自定义数据将通过<a href="https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83">企业引导个人实名认证后回调</a>返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。</p>
21071
21040
  :rtype: str
21072
21041
  """
21073
21042
  return self._UserData
@@ -21106,31 +21075,11 @@ class CreateUserVerifyUrlResponse(AbstractModel):
21106
21075
 
21107
21076
  def __init__(self):
21108
21077
  r"""
21109
- :param _UserVerifyUrl: 腾讯电子签小程序的实名认证链接。
21110
- 如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
21111
-
21112
- <strong>1.如果EndPoint是APP</strong>:
21113
- 得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
21114
-
21115
- <strong>2.如果EndPoint是HTTP</strong>:
21116
- 得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署
21117
-
21118
- <strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:
21119
- 得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署
21120
-
21121
- <strong>4.如果EndPoint是H5</strong>:
21122
- 得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署
21123
-
21124
- <strong>5.如果EndPoint是H5_SHORT_URL</strong>:
21125
- 得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署
21126
-
21127
-
21128
- `注:` <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>
21129
- 示例值:https://essurl.cn/2n**42Nd
21078
+ :param _UserVerifyUrl: <p>腾讯电子签小程序的实名认证链接。<br>如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。</p><p><strong>1.如果EndPoint是APP</strong>:<br>得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&amp;shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的&quot;跳转到小程序的实现&quot;</p><p><strong>2.如果EndPoint是HTTP</strong>:<br>得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&amp;shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署</p><p><strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:<br>得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署</p><p><strong>4.如果EndPoint是H5</strong>:<br>得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU<strong><strong>VJhsS5q&amp;CodeType=xxx&amp;shortKey=yD*</strong></strong>frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署</p><p><strong>5.如果EndPoint是H5_SHORT_URL</strong>:<br>得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署</p><p><code>注:</code> <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font><br>示例值:https://essurl.cn/2n**42Nd</p>
21130
21079
  :type UserVerifyUrl: str
21131
- :param _ExpireTime: 链接过期时间,为Unix时间戳(单位为秒)。
21080
+ :param _ExpireTime: <p>链接过期时间,为Unix时间戳(单位为秒)。</p>
21132
21081
  :type ExpireTime: int
21133
- :param _MiniAppId: 小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回
21082
+ :param _MiniAppId: <p>小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回</p>
21134
21083
  :type MiniAppId: str
21135
21084
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
21136
21085
  :type RequestId: str
@@ -21142,27 +21091,7 @@ class CreateUserVerifyUrlResponse(AbstractModel):
21142
21091
 
21143
21092
  @property
21144
21093
  def UserVerifyUrl(self):
21145
- r"""腾讯电子签小程序的实名认证链接。
21146
- 如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
21147
-
21148
- <strong>1.如果EndPoint是APP</strong>:
21149
- 得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
21150
-
21151
- <strong>2.如果EndPoint是HTTP</strong>:
21152
- 得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署
21153
-
21154
- <strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:
21155
- 得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署
21156
-
21157
- <strong>4.如果EndPoint是H5</strong>:
21158
- 得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署
21159
-
21160
- <strong>5.如果EndPoint是H5_SHORT_URL</strong>:
21161
- 得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署
21162
-
21163
-
21164
- `注:` <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>
21165
- 示例值:https://essurl.cn/2n**42Nd
21094
+ r"""<p>腾讯电子签小程序的实名认证链接。<br>如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。</p><p><strong>1.如果EndPoint是APP</strong>:<br>得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&amp;shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的&quot;跳转到小程序的实现&quot;</p><p><strong>2.如果EndPoint是HTTP</strong>:<br>得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&amp;shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署</p><p><strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:<br>得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署</p><p><strong>4.如果EndPoint是H5</strong>:<br>得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU<strong><strong>VJhsS5q&amp;CodeType=xxx&amp;shortKey=yD*</strong></strong>frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署</p><p><strong>5.如果EndPoint是H5_SHORT_URL</strong>:<br>得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署</p><p><code>注:</code> <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font><br>示例值:https://essurl.cn/2n**42Nd</p>
21166
21095
  :rtype: str
21167
21096
  """
21168
21097
  return self._UserVerifyUrl
@@ -21173,7 +21102,7 @@ class CreateUserVerifyUrlResponse(AbstractModel):
21173
21102
 
21174
21103
  @property
21175
21104
  def ExpireTime(self):
21176
- r"""链接过期时间,为Unix时间戳(单位为秒)。
21105
+ r"""<p>链接过期时间,为Unix时间戳(单位为秒)。</p>
21177
21106
  :rtype: int
21178
21107
  """
21179
21108
  return self._ExpireTime
@@ -21184,7 +21113,7 @@ class CreateUserVerifyUrlResponse(AbstractModel):
21184
21113
 
21185
21114
  @property
21186
21115
  def MiniAppId(self):
21187
- r"""小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回
21116
+ r"""<p>小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回</p>
21188
21117
  :rtype: str
21189
21118
  """
21190
21119
  return self._MiniAppId
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.187
3
+ Version: 3.1.191
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.187
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.191
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.191
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.187