tencentcloud-sdk-python 3.0.1290__py2.py3-none-any.whl → 3.0.1292__py2.py3-none-any.whl

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 (63) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/apm/v20210622/apm_client.py +5 -5
  3. tencentcloud/apm/v20210622/errorcodes.py +3 -0
  4. tencentcloud/apm/v20210622/models.py +30 -30
  5. tencentcloud/autoscaling/v20180419/models.py +21 -2
  6. tencentcloud/batch/v20170312/models.py +2 -2
  7. tencentcloud/billing/v20180709/models.py +30 -0
  8. tencentcloud/cdb/v20170320/cdb_client.py +1 -1
  9. tencentcloud/cdb/v20170320/models.py +8 -468
  10. tencentcloud/cdwdoris/v20211228/models.py +64 -0
  11. tencentcloud/cfg/v20210820/models.py +15 -0
  12. tencentcloud/cls/v20201016/models.py +2 -2
  13. tencentcloud/cmq/v20190304/cmq_client.py +30 -10
  14. tencentcloud/cmq/v20190304/models.py +106 -106
  15. tencentcloud/csip/v20221121/csip_client.py +115 -0
  16. tencentcloud/csip/v20221121/models.py +10798 -8153
  17. tencentcloud/cvm/v20170312/cvm_client.py +0 -115
  18. tencentcloud/cvm/v20170312/errorcodes.py +3 -9
  19. tencentcloud/cvm/v20170312/models.py +7379 -8874
  20. tencentcloud/cwp/v20180228/cwp_client.py +0 -25
  21. tencentcloud/cwp/v20180228/models.py +0 -49
  22. tencentcloud/cynosdb/v20190107/cynosdb_client.py +3 -3
  23. tencentcloud/cynosdb/v20190107/errorcodes.py +3 -0
  24. tencentcloud/cynosdb/v20190107/models.py +8 -32
  25. tencentcloud/dts/v20180330/models.py +2 -2
  26. tencentcloud/dts/v20211206/models.py +17 -0
  27. tencentcloud/emr/v20190103/emr_client.py +207 -0
  28. tencentcloud/emr/v20190103/errorcodes.py +15 -0
  29. tencentcloud/emr/v20190103/models.py +2175 -248
  30. tencentcloud/ess/v20201111/models.py +58 -38
  31. tencentcloud/essbasic/v20210526/models.py +33 -20
  32. tencentcloud/faceid/v20180301/models.py +4 -4
  33. tencentcloud/iai/v20200303/errorcodes.py +15 -0
  34. tencentcloud/iai/v20200303/iai_client.py +28 -0
  35. tencentcloud/iai/v20200303/models.py +203 -0
  36. tencentcloud/iotexplorer/v20190423/models.py +15 -0
  37. tencentcloud/keewidb/v20220308/models.py +2 -2
  38. tencentcloud/live/v20180801/models.py +111 -56
  39. tencentcloud/mna/v20210119/mna_client.py +9 -3
  40. tencentcloud/mps/v20190612/models.py +60 -0
  41. tencentcloud/oceanus/v20190422/errorcodes.py +3 -0
  42. tencentcloud/oceanus/v20190422/models.py +571 -2
  43. tencentcloud/ocr/v20181119/models.py +75 -0
  44. tencentcloud/sqlserver/v20180328/models.py +185 -90
  45. tencentcloud/sqlserver/v20180328/sqlserver_client.py +1 -1
  46. tencentcloud/ssl/v20191205/models.py +6 -6
  47. tencentcloud/tbaas/v20180416/tbaas_client.py +2 -2
  48. tencentcloud/tcr/v20190924/models.py +15 -0
  49. tencentcloud/tdmq/v20200217/models.py +30 -0
  50. tencentcloud/tem/v20210701/models.py +2 -2
  51. tencentcloud/tem/v20210701/tem_client.py +3 -1
  52. tencentcloud/tke/v20180525/models.py +21 -6
  53. tencentcloud/tse/v20201207/models.py +68 -0
  54. tencentcloud/tts/v20190823/models.py +2 -2
  55. tencentcloud/vpc/v20170312/models.py +479 -0
  56. tencentcloud/vpc/v20170312/vpc_client.py +69 -0
  57. tencentcloud/waf/v20180125/models.py +546 -4
  58. tencentcloud/waf/v20180125/waf_client.py +70 -1
  59. {tencentcloud_sdk_python-3.0.1290.dist-info → tencentcloud_sdk_python-3.0.1292.dist-info}/METADATA +1 -1
  60. {tencentcloud_sdk_python-3.0.1290.dist-info → tencentcloud_sdk_python-3.0.1292.dist-info}/RECORD +63 -63
  61. {tencentcloud_sdk_python-3.0.1290.dist-info → tencentcloud_sdk_python-3.0.1292.dist-info}/LICENSE +0 -0
  62. {tencentcloud_sdk_python-3.0.1290.dist-info → tencentcloud_sdk_python-3.0.1292.dist-info}/WHEEL +0 -0
  63. {tencentcloud_sdk_python-3.0.1290.dist-info → tencentcloud_sdk_python-3.0.1292.dist-info}/top_level.txt +0 -0
@@ -940,12 +940,20 @@ class ApproverOption(AbstractModel):
940
940
  <li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li>
941
941
  </ul>
942
942
  :type FlowReadLimit: str
943
+ :param _ForbidAddSignDate: 禁止在签署过程中添加签署日期控件
944
+ <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):
945
+ <ul>
946
+ <li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>
947
+ <li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>
948
+ </ul>
949
+ :type ForbidAddSignDate: bool
943
950
  """
944
951
  self._NoRefuse = None
945
952
  self._NoTransfer = None
946
953
  self._CanEditApprover = None
947
954
  self._FillType = None
948
955
  self._FlowReadLimit = None
956
+ self._ForbidAddSignDate = None
949
957
 
950
958
  @property
951
959
  def NoRefuse(self):
@@ -1020,6 +1028,22 @@ class ApproverOption(AbstractModel):
1020
1028
  def FlowReadLimit(self, FlowReadLimit):
1021
1029
  self._FlowReadLimit = FlowReadLimit
1022
1030
 
1031
+ @property
1032
+ def ForbidAddSignDate(self):
1033
+ """禁止在签署过程中添加签署日期控件
1034
+ <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):
1035
+ <ul>
1036
+ <li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>
1037
+ <li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>
1038
+ </ul>
1039
+ :rtype: bool
1040
+ """
1041
+ return self._ForbidAddSignDate
1042
+
1043
+ @ForbidAddSignDate.setter
1044
+ def ForbidAddSignDate(self, ForbidAddSignDate):
1045
+ self._ForbidAddSignDate = ForbidAddSignDate
1046
+
1023
1047
 
1024
1048
  def _deserialize(self, params):
1025
1049
  self._NoRefuse = params.get("NoRefuse")
@@ -1027,6 +1051,7 @@ class ApproverOption(AbstractModel):
1027
1051
  self._CanEditApprover = params.get("CanEditApprover")
1028
1052
  self._FillType = params.get("FillType")
1029
1053
  self._FlowReadLimit = params.get("FlowReadLimit")
1054
+ self._ForbidAddSignDate = params.get("ForbidAddSignDate")
1030
1055
  memeber_set = set(params.keys())
1031
1056
  for name, value in vars(self).items():
1032
1057
  property_name = name[1:]
@@ -5146,11 +5171,9 @@ class CreateBatchSignUrlRequest(AbstractModel):
5146
5171
  2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
5147
5172
  3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
5148
5173
  :type AutoJumpBack: bool
5149
- :param _UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
5174
+ :param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
5150
5175
 
5151
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
5152
-
5153
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
5176
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)
5154
5177
  :type UrlUseEnv: str
5155
5178
  """
5156
5179
  self._Operator = None
@@ -5341,11 +5364,9 @@ class CreateBatchSignUrlRequest(AbstractModel):
5341
5364
 
5342
5365
  @property
5343
5366
  def UrlUseEnv(self):
5344
- """签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
5345
-
5346
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
5367
+ """<font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
5347
5368
 
5348
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
5369
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
5349
5370
  :rtype: str
5350
5371
  """
5351
5372
  return self._UrlUseEnv
@@ -12688,7 +12709,7 @@ class CreatePrepareFlowRequest(AbstractModel):
12688
12709
  :type UserData: str
12689
12710
  :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
12690
12711
 
12691
- :type CcInfos: :class:`tencentcloud.ess.v20201111.models.CcInfo`
12712
+ :type CcInfos: list of CcInfo
12692
12713
  :param _FlowId: 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
12693
12714
  注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
12694
12715
  :type FlowId: str
@@ -12927,7 +12948,7 @@ class CreatePrepareFlowRequest(AbstractModel):
12927
12948
  def CcInfos(self):
12928
12949
  """合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
12929
12950
 
12930
- :rtype: :class:`tencentcloud.ess.v20201111.models.CcInfo`
12951
+ :rtype: list of CcInfo
12931
12952
  """
12932
12953
  return self._CcInfos
12933
12954
 
@@ -13011,8 +13032,11 @@ class CreatePrepareFlowRequest(AbstractModel):
13011
13032
  self._NeedCreateReview = params.get("NeedCreateReview")
13012
13033
  self._UserData = params.get("UserData")
13013
13034
  if params.get("CcInfos") is not None:
13014
- self._CcInfos = CcInfo()
13015
- self._CcInfos._deserialize(params.get("CcInfos"))
13035
+ self._CcInfos = []
13036
+ for item in params.get("CcInfos"):
13037
+ obj = CcInfo()
13038
+ obj._deserialize(item)
13039
+ self._CcInfos.append(obj)
13016
13040
  self._FlowId = params.get("FlowId")
13017
13041
  if params.get("Agent") is not None:
13018
13042
  self._Agent = Agent()
@@ -13787,13 +13811,9 @@ class CreateSchemeUrlRequest(AbstractModel):
13787
13811
  :type RecipientId: str
13788
13812
  :param _FlowGroupUrlInfo: 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
13789
13813
  :type FlowGroupUrlInfo: :class:`tencentcloud.ess.v20201111.models.FlowGroupUrlInfo`
13790
- :param _UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
13791
-
13792
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
13793
-
13794
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
13795
-
13814
+ :param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
13796
13815
 
13816
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
13797
13817
  :type UrlUseEnv: str
13798
13818
  """
13799
13819
  self._Operator = None
@@ -14009,13 +14029,9 @@ class CreateSchemeUrlRequest(AbstractModel):
14009
14029
 
14010
14030
  @property
14011
14031
  def UrlUseEnv(self):
14012
- """签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
14013
-
14014
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
14015
-
14016
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
14017
-
14032
+ """<font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
14018
14033
 
14034
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
14019
14035
  :rtype: str
14020
14036
  """
14021
14037
  return self._UrlUseEnv
@@ -18949,10 +18965,8 @@ class DescribeFlowTemplatesRequest(AbstractModel):
18949
18965
  <ul><li>**0**:模板列表及详情(默认)</li>
18950
18966
  <li>**1**:仅模板列表</li></ul>
18951
18967
  :type ContentType: int
18952
- :param _Filters: 搜索条件,本字段用于指定模板Id进行查询。
18953
- - Keytemplate-id Values:需要查询的模板Id列表
18954
- - Key:template-name Values:需要查询的模板名称列表
18955
-
18968
+ :param _Filters: 搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。
18969
+ <ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li></ul>
18956
18970
  :type Filters: list of Filter
18957
18971
  :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
18958
18972
 
@@ -18963,9 +18977,10 @@ class DescribeFlowTemplatesRequest(AbstractModel):
18963
18977
 
18964
18978
  注:`1.默认值为20,单页做大值为200。`
18965
18979
  :type Limit: int
18966
- :param _ApplicationId: 指定查询的应用号,指定后查询该应用号下的模板列表。
18980
+ :param _ApplicationId: 通过指定[第三方应用的应用号(ApplicationId)](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png),您可以查询<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中某个第三方应用下的模板。
18967
18981
 
18968
- 注:`1.ApplicationId为空时,查询所有应用下的模板列表。`
18982
+ <p><strong>注意事项:</strong></p>
18983
+ <ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href="https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png" target="_blank">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>
18969
18984
  :type ApplicationId: str
18970
18985
  :param _IsChannel: 默认为false,查询SaaS模板库列表;
18971
18986
  为true,查询第三方应用集成平台企业模板库管理列表
@@ -18974,7 +18989,10 @@ class DescribeFlowTemplatesRequest(AbstractModel):
18974
18989
  :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
18975
18990
  :param _GenerateSource: 暂未开放
18976
18991
  :type GenerateSource: int
18977
- :param _WithPreviewUrl: 是否获取模板预览链接
18992
+ :param _WithPreviewUrl: 是否获取模板预览链接。
18993
+
18994
+ <ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>
18995
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
18978
18996
  :type WithPreviewUrl: bool
18979
18997
  """
18980
18998
  self._Operator = None
@@ -19029,10 +19047,8 @@ class DescribeFlowTemplatesRequest(AbstractModel):
19029
19047
 
19030
19048
  @property
19031
19049
  def Filters(self):
19032
- """搜索条件,本字段用于指定模板Id进行查询。
19033
- - Keytemplate-id Values:需要查询的模板Id列表
19034
- - Key:template-name Values:需要查询的模板名称列表
19035
-
19050
+ """搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。
19051
+ <ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li></ul>
19036
19052
  :rtype: list of Filter
19037
19053
  """
19038
19054
  return self._Filters
@@ -19070,9 +19086,10 @@ class DescribeFlowTemplatesRequest(AbstractModel):
19070
19086
 
19071
19087
  @property
19072
19088
  def ApplicationId(self):
19073
- """指定查询的应用号,指定后查询该应用号下的模板列表。
19089
+ """通过指定[第三方应用的应用号(ApplicationId)](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png),您可以查询<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中某个第三方应用下的模板。
19074
19090
 
19075
- 注:`1.ApplicationId为空时,查询所有应用下的模板列表。`
19091
+ <p><strong>注意事项:</strong></p>
19092
+ <ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href="https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png" target="_blank">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>
19076
19093
  :rtype: str
19077
19094
  """
19078
19095
  return self._ApplicationId
@@ -19129,7 +19146,10 @@ class DescribeFlowTemplatesRequest(AbstractModel):
19129
19146
 
19130
19147
  @property
19131
19148
  def WithPreviewUrl(self):
19132
- """是否获取模板预览链接
19149
+ """是否获取模板预览链接。
19150
+
19151
+ <ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>
19152
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
19133
19153
  :rtype: bool
19134
19154
  """
19135
19155
  return self._WithPreviewUrl
@@ -306,12 +306,20 @@ true:隐藏,每个签署区要单独选择印章或者签名
306
306
  <li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li>
307
307
  </ul>
308
308
  :type FlowReadLimit: str
309
+ :param _ForbidAddSignDate: 禁止在签署过程中添加签署日期控件
310
+ <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):
311
+ <ul>
312
+ <li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>
313
+ <li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>
314
+ </ul>
315
+ :type ForbidAddSignDate: bool
309
316
  """
310
317
  self._NoRefuse = None
311
318
  self._NoTransfer = None
312
319
  self._HideOneKeySign = None
313
320
  self._FillType = None
314
321
  self._FlowReadLimit = None
322
+ self._ForbidAddSignDate = None
315
323
 
316
324
  @property
317
325
  def NoRefuse(self):
@@ -383,6 +391,22 @@ true:隐藏,每个签署区要单独选择印章或者签名
383
391
  def FlowReadLimit(self, FlowReadLimit):
384
392
  self._FlowReadLimit = FlowReadLimit
385
393
 
394
+ @property
395
+ def ForbidAddSignDate(self):
396
+ """禁止在签署过程中添加签署日期控件
397
+ <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):
398
+ <ul>
399
+ <li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>
400
+ <li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>
401
+ </ul>
402
+ :rtype: bool
403
+ """
404
+ return self._ForbidAddSignDate
405
+
406
+ @ForbidAddSignDate.setter
407
+ def ForbidAddSignDate(self, ForbidAddSignDate):
408
+ self._ForbidAddSignDate = ForbidAddSignDate
409
+
386
410
 
387
411
  def _deserialize(self, params):
388
412
  self._NoRefuse = params.get("NoRefuse")
@@ -390,6 +414,7 @@ true:隐藏,每个签署区要单独选择印章或者签名
390
414
  self._HideOneKeySign = params.get("HideOneKeySign")
391
415
  self._FillType = params.get("FillType")
392
416
  self._FlowReadLimit = params.get("FlowReadLimit")
417
+ self._ForbidAddSignDate = params.get("ForbidAddSignDate")
393
418
  memeber_set = set(params.keys())
394
419
  for name, value in vars(self).items():
395
420
  property_name = name[1:]
@@ -2939,11 +2964,9 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
2939
2964
  2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
2940
2965
  3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
2941
2966
  :type AutoJumpBack: bool
2942
- :param _UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
2967
+ :param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
2943
2968
 
2944
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
2945
-
2946
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
2969
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)
2947
2970
  :type UrlUseEnv: str
2948
2971
  """
2949
2972
  self._Agent = None
@@ -3172,11 +3195,9 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
3172
3195
 
3173
3196
  @property
3174
3197
  def UrlUseEnv(self):
3175
- """签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
3176
-
3177
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
3198
+ """<font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
3178
3199
 
3179
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
3200
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
3180
3201
  :rtype: str
3181
3202
  """
3182
3203
  return self._UrlUseEnv
@@ -16716,13 +16737,9 @@ class CreateSignUrlsRequest(AbstractModel):
16716
16737
  :type RecipientIds: list of str
16717
16738
  :param _FlowGroupUrlInfo: 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
16718
16739
  :type FlowGroupUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupUrlInfo`
16719
- :param _UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
16720
-
16721
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
16722
-
16723
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
16724
-
16740
+ :param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
16725
16741
 
16742
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
16726
16743
  :type UrlUseEnv: str
16727
16744
  """
16728
16745
  self._Agent = None
@@ -17004,13 +17021,9 @@ class CreateSignUrlsRequest(AbstractModel):
17004
17021
 
17005
17022
  @property
17006
17023
  def UrlUseEnv(self):
17007
- """签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
17008
-
17009
- 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
17010
-
17011
- 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
17012
-
17024
+ """<font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
17013
17025
 
17026
+ 参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
17014
17027
  :rtype: str
17015
17028
  """
17016
17029
  return self._UrlUseEnv
@@ -9368,7 +9368,7 @@ class ParseNfcDataResponse(AbstractModel):
9368
9368
  07 :台胞证 。
9369
9369
  08:外国护照 。
9370
9370
  09 :士兵证。
9371
- 09 :临时身份证。
9371
+ 10 :临时身份证。
9372
9372
  11:户口本 。
9373
9373
  12 :警官证 。
9374
9374
  13:外国人永久居留证。
@@ -9395,7 +9395,7 @@ class ParseNfcDataResponse(AbstractModel):
9395
9395
  :type PersonalNumber: str
9396
9396
  :param _CheckMRTD: 旅行证件类的核验结果。
9397
9397
  - JSON格式如下:
9398
- {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
9398
+ {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
9399
9399
  - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。
9400
9400
  注意:此字段可能返回 null,表示取不到有效值。
9401
9401
  :type CheckMRTD: str
@@ -9566,7 +9566,7 @@ class ParseNfcDataResponse(AbstractModel):
9566
9566
  07 :台胞证 。
9567
9567
  08:外国护照 。
9568
9568
  09 :士兵证。
9569
- 09 :临时身份证。
9569
+ 10 :临时身份证。
9570
9570
  11:户口本 。
9571
9571
  12 :警官证 。
9572
9572
  13:外国人永久居留证。
@@ -9647,7 +9647,7 @@ class ParseNfcDataResponse(AbstractModel):
9647
9647
  def CheckMRTD(self):
9648
9648
  """旅行证件类的核验结果。
9649
9649
  - JSON格式如下:
9650
- {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
9650
+ {"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 。
9651
9651
  - 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。
9652
9652
  注意:此字段可能返回 null,表示取不到有效值。
9653
9653
  :rtype: str
@@ -23,6 +23,9 @@ FAILEDOPERATION = 'FailedOperation'
23
23
  # 该操作不支持跨算法模型版本。
24
24
  FAILEDOPERATION_ACROSSVERSIONSERROR = 'FailedOperation.AcrossVersionsError'
25
25
 
26
+ # 比对失败。
27
+ FAILEDOPERATION_COMPAREFAIL = 'FailedOperation.CompareFail'
28
+
26
29
  # 操作冲突,请勿同时操作相同的Person。
27
30
  FAILEDOPERATION_CONFLICTOPERATION = 'FailedOperation.ConflictOperation'
28
31
 
@@ -74,6 +77,18 @@ FAILEDOPERATION_IMAGESIZEEXCEED = 'FailedOperation.ImageSizeExceed'
74
77
  # 任务无法回滚。
75
78
  FAILEDOPERATION_JOBCANNNOTROLLBACK = 'FailedOperation.JobCannnotRollback'
76
79
 
80
+ # 检测到多张人脸。
81
+ FAILEDOPERATION_LIFEPHOTODETECTFACES = 'FailedOperation.LifePhotoDetectFaces'
82
+
83
+ # 实人比对没通过。
84
+ FAILEDOPERATION_LIFEPHOTODETECTFAKE = 'FailedOperation.LifePhotoDetectFake'
85
+
86
+ # 未能检测到完整人脸。
87
+ FAILEDOPERATION_LIFEPHOTODETECTNOFACES = 'FailedOperation.LifePhotoDetectNoFaces'
88
+
89
+ # 传入图片过大或过小。
90
+ FAILEDOPERATION_LIFEPHOTOSIZEERROR = 'FailedOperation.LifePhotoSizeError'
91
+
77
92
  # 请求频率超过限制。
78
93
  FAILEDOPERATION_REQUESTLIMITEXCEEDED = 'FailedOperation.RequestLimitExceeded'
79
94
 
@@ -407,6 +407,34 @@ class IaiClient(AbstractClient):
407
407
  raise TencentCloudSDKException(type(e).__name__, str(e))
408
408
 
409
409
 
410
+ def DetectFaceSimilarity(self, request):
411
+ """对两张图片中的人脸进行相似度比对,返回人脸相似度分数。
412
+
413
+ 若您需要判断 “此人是否是某人”,即验证某张图片中的人是否是已知身份的某人,如常见的人脸登录场景,建议使用[人脸验证](https://www.tencentcloud.com/document/product/1059/36972)或[人员验证](https://www.tencentcloud.com/document/product/1059/36971)接口。
414
+
415
+ >
416
+ - 公共参数中的签名方式请使用V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。
417
+
418
+ :param request: Request instance for DetectFaceSimilarity.
419
+ :type request: :class:`tencentcloud.iai.v20200303.models.DetectFaceSimilarityRequest`
420
+ :rtype: :class:`tencentcloud.iai.v20200303.models.DetectFaceSimilarityResponse`
421
+
422
+ """
423
+ try:
424
+ params = request._serialize()
425
+ headers = request.headers
426
+ body = self.call("DetectFaceSimilarity", params, headers=headers)
427
+ response = json.loads(body)
428
+ model = models.DetectFaceSimilarityResponse()
429
+ model._deserialize(response["Response"])
430
+ return model
431
+ except Exception as e:
432
+ if isinstance(e, TencentCloudSDKException):
433
+ raise
434
+ else:
435
+ raise TencentCloudSDKException(type(e).__name__, str(e))
436
+
437
+
410
438
  def DetectLiveFace(self, request):
411
439
  """用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是:静态活体检测中,用户不需要通过唇语或摇头眨眼等动作来识别。
412
440