tencentcloud-sdk-python 3.0.1233__py2.py3-none-any.whl → 3.0.1246__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 (110) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/aiart/v20221229/aiart_client.py +34 -21
  3. tencentcloud/aiart/v20221229/models.py +6 -6
  4. tencentcloud/apigateway/v20180808/apigateway_client.py +23 -0
  5. tencentcloud/apigateway/v20180808/models.py +31 -0
  6. tencentcloud/apm/v20210622/errorcodes.py +3 -3
  7. tencentcloud/apm/v20210622/models.py +16 -15
  8. tencentcloud/asr/v20190614/asr_client.py +23 -0
  9. tencentcloud/asr/v20190614/models.py +203 -0
  10. tencentcloud/autoscaling/v20180419/models.py +55 -3
  11. tencentcloud/ca/__init__.py +0 -0
  12. tencentcloud/ca/v20230228/__init__.py +0 -0
  13. tencentcloud/ca/v20230228/ca_client.py +95 -0
  14. tencentcloud/ca/v20230228/errorcodes.py +30 -0
  15. tencentcloud/ca/v20230228/models.py +398 -0
  16. tencentcloud/ccc/v20200210/ccc_client.py +69 -0
  17. tencentcloud/ccc/v20200210/errorcodes.py +6 -0
  18. tencentcloud/ccc/v20200210/models.py +610 -0
  19. tencentcloud/cdb/v20170320/models.py +60 -0
  20. tencentcloud/cdn/v20180606/models.py +32 -0
  21. tencentcloud/cdwdoris/v20211228/models.py +105 -1
  22. tencentcloud/cfg/v20210820/models.py +12 -0
  23. tencentcloud/cfw/v20190904/models.py +4 -4
  24. tencentcloud/clb/v20180317/models.py +25 -1
  25. tencentcloud/cls/v20201016/models.py +12 -0
  26. tencentcloud/cme/v20191029/models.py +12 -0
  27. tencentcloud/csip/v20221121/models.py +1 -1
  28. tencentcloud/cvm/v20170312/cvm_client.py +23 -0
  29. tencentcloud/cvm/v20170312/errorcodes.py +4 -1
  30. tencentcloud/cvm/v20170312/models.py +202 -4
  31. tencentcloud/cwp/v20180228/cwp_client.py +3 -1
  32. tencentcloud/cwp/v20180228/models.py +241 -14
  33. tencentcloud/cynosdb/v20190107/cynosdb_client.py +48 -73
  34. tencentcloud/cynosdb/v20190107/models.py +7 -134
  35. tencentcloud/dasb/v20191018/models.py +37 -0
  36. tencentcloud/dlc/v20210125/models.py +12 -0
  37. tencentcloud/dsgc/v20190723/models.py +1 -1
  38. tencentcloud/dts/v20211206/models.py +16 -16
  39. tencentcloud/emr/v20190103/emr_client.py +46 -0
  40. tencentcloud/emr/v20190103/models.py +467 -3
  41. tencentcloud/ess/v20201111/ess_client.py +19 -12
  42. tencentcloud/ess/v20201111/models.py +58 -22
  43. tencentcloud/essbasic/v20210526/essbasic_client.py +48 -9
  44. tencentcloud/essbasic/v20210526/models.py +174 -11
  45. tencentcloud/faceid/v20180301/models.py +28 -0
  46. tencentcloud/hunyuan/v20230901/models.py +1 -0
  47. tencentcloud/iecp/v20210914/iecp_client.py +0 -500
  48. tencentcloud/iecp/v20210914/models.py +2130 -5305
  49. tencentcloud/ims/v20201229/ims_client.py +9 -4
  50. tencentcloud/ims/v20201229/models.py +4 -4
  51. tencentcloud/lcic/v20220817/models.py +1 -1
  52. tencentcloud/lighthouse/v20200324/models.py +2 -2
  53. tencentcloud/lke/v20231130/lke_client.py +184 -0
  54. tencentcloud/lke/v20231130/models.py +2129 -881
  55. tencentcloud/mariadb/v20170312/mariadb_client.py +23 -0
  56. tencentcloud/mariadb/v20170312/models.py +94 -0
  57. tencentcloud/monitor/v20180724/models.py +0 -132
  58. tencentcloud/monitor/v20180724/monitor_client.py +0 -50
  59. tencentcloud/mps/v20190612/models.py +16 -3
  60. tencentcloud/mqtt/__init__.py +0 -0
  61. tencentcloud/mqtt/v20240516/__init__.py +0 -0
  62. tencentcloud/mqtt/v20240516/errorcodes.py +45 -0
  63. tencentcloud/mqtt/v20240516/models.py +3221 -0
  64. tencentcloud/mqtt/v20240516/mqtt_client.py +472 -0
  65. tencentcloud/mrs/v20200910/errorcodes.py +3 -0
  66. tencentcloud/mrs/v20200910/models.py +158 -27
  67. tencentcloud/ocr/v20181119/models.py +21 -0
  68. tencentcloud/ocr/v20181119/ocr_client.py +1 -1
  69. tencentcloud/omics/v20221128/models.py +245 -29
  70. tencentcloud/organization/v20210331/errorcodes.py +54 -0
  71. tencentcloud/organization/v20210331/models.py +483 -3
  72. tencentcloud/organization/v20210331/organization_client.py +46 -0
  73. tencentcloud/postgres/v20170312/models.py +626 -13
  74. tencentcloud/postgres/v20170312/postgres_client.py +69 -0
  75. tencentcloud/rce/v20201103/models.py +33 -22
  76. tencentcloud/redis/v20180412/errorcodes.py +3 -0
  77. tencentcloud/scf/v20180416/errorcodes.py +9 -12
  78. tencentcloud/ses/v20201002/models.py +65 -0
  79. tencentcloud/sms/v20190711/models.py +3 -3
  80. tencentcloud/sms/v20210111/models.py +9 -8
  81. tencentcloud/sqlserver/v20180328/models.py +1 -1
  82. tencentcloud/ssl/v20191205/models.py +114 -0
  83. tencentcloud/tcb/v20180608/models.py +25 -0
  84. tencentcloud/tcss/v20201101/models.py +269 -0
  85. tencentcloud/tcss/v20201101/tcss_client.py +3 -1
  86. tencentcloud/teo/v20220901/errorcodes.py +33 -0
  87. tencentcloud/teo/v20220901/models.py +4012 -2535
  88. tencentcloud/teo/v20220901/teo_client.py +254 -0
  89. tencentcloud/tke/v20180525/errorcodes.py +3 -0
  90. tencentcloud/tke/v20180525/models.py +748 -5
  91. tencentcloud/tke/v20180525/tke_client.py +92 -0
  92. tencentcloud/tke/v20220501/models.py +1 -1
  93. tencentcloud/tse/v20201207/models.py +26 -0
  94. tencentcloud/tsf/v20180326/models.py +0 -58
  95. tencentcloud/tsf/v20180326/tsf_client.py +0 -25
  96. tencentcloud/tts/v20190823/tts_client.py +4 -1
  97. tencentcloud/vclm/v20240523/models.py +25 -0
  98. tencentcloud/vdb/v20230616/models.py +13 -0
  99. tencentcloud/vod/v20180717/models.py +91 -1
  100. tencentcloud/vod/v20180717/vod_client.py +10 -2
  101. tencentcloud/vpc/v20170312/errorcodes.py +9 -0
  102. tencentcloud/vpc/v20170312/models.py +2587 -539
  103. tencentcloud/vpc/v20170312/vpc_client.py +506 -0
  104. tencentcloud/waf/v20180125/models.py +447 -12
  105. tencentcloud/wedata/v20210820/models.py +18 -0
  106. {tencentcloud_sdk_python-3.0.1233.dist-info → tencentcloud_sdk_python-3.0.1246.dist-info}/METADATA +1 -1
  107. {tencentcloud_sdk_python-3.0.1233.dist-info → tencentcloud_sdk_python-3.0.1246.dist-info}/RECORD +110 -100
  108. {tencentcloud_sdk_python-3.0.1233.dist-info → tencentcloud_sdk_python-3.0.1246.dist-info}/LICENSE +0 -0
  109. {tencentcloud_sdk_python-3.0.1233.dist-info → tencentcloud_sdk_python-3.0.1246.dist-info}/WHEEL +0 -0
  110. {tencentcloud_sdk_python-3.0.1233.dist-info → tencentcloud_sdk_python-3.0.1246.dist-info}/top_level.txt +0 -0
@@ -65,7 +65,7 @@ class EssClient(AbstractClient):
65
65
 
66
66
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
67
67
 
68
- 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
68
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
69
69
 
70
70
  :param request: Request instance for CancelFlow.
71
71
  :type request: :class:`tencentcloud.ess.v20201111.models.CancelFlowRequest`
@@ -158,6 +158,8 @@ class EssClient(AbstractClient):
158
158
 
159
159
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
160
160
 
161
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
162
+
161
163
  :param request: Request instance for CreateBatchCancelFlowUrl.
162
164
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateBatchCancelFlowUrlRequest`
163
165
  :rtype: :class:`tencentcloud.ess.v20201111.models.CreateBatchCancelFlowUrlResponse`
@@ -282,13 +284,12 @@ class EssClient(AbstractClient):
282
284
 
283
285
 
284
286
  def CreateBatchQuickSignUrl(self, request):
285
- """该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
287
+ """该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
286
288
  **注意:**
287
289
  1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
288
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
289
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
290
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
291
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
290
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
291
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
292
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
292
293
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
293
294
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
294
295
 
@@ -377,7 +378,7 @@ class EssClient(AbstractClient):
377
378
  ### 调用流程
378
379
  该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
379
380
 
380
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
381
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
381
382
 
382
383
 
383
384
  ### 填充模板中定义的填写控件
@@ -561,7 +562,7 @@ class EssClient(AbstractClient):
561
562
 
562
563
  注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
563
564
 
564
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
565
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
565
566
 
566
567
  注:**静默(自动)签署不支持合同签署方存在填写**功能
567
568
  <br>
@@ -1504,6 +1505,8 @@ class EssClient(AbstractClient):
1504
1505
  <li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>
1505
1506
  </ul>
1506
1507
 
1508
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)
1509
+
1507
1510
  :param request: Request instance for CreateReleaseFlow.
1508
1511
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowRequest`
1509
1512
  :rtype: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowResponse`
@@ -2068,8 +2071,7 @@ class EssClient(AbstractClient):
2068
2071
 
2069
2072
 
2070
2073
  def DescribeFlowBriefs(self, request):
2071
- """查询流程基础信息
2072
- 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
2074
+ """查询流程基础信息,主要用于<font color="red">查询合同的状态</font>信息。可以配合回调通知使用。
2073
2075
 
2074
2076
  注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
2075
2077
 
@@ -2094,7 +2096,12 @@ class EssClient(AbstractClient):
2094
2096
 
2095
2097
 
2096
2098
  def DescribeFlowComponents(self, request):
2097
- """可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。
2099
+ """可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
2100
+
2101
+
2102
+ 如下图模板所示,发起后对方填写后,可以获取红框中用户填写的信息。
2103
+
2104
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
2098
2105
 
2099
2106
  :param request: Request instance for DescribeFlowComponents.
2100
2107
  :type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowComponentsRequest`
@@ -2731,7 +2738,7 @@ class EssClient(AbstractClient):
2731
2738
  """此接口用于启动流程。它是模板发起合同的最后一步。
2732
2739
  在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
2733
2740
 
2734
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
2741
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
2735
2742
 
2736
2743
  注:
2737
2744
  1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
@@ -233,12 +233,15 @@ class ApproverInfo(AbstractModel):
233
233
  <li> 企业印章</li>
234
234
  <li> 骑缝章等签署控件</li></ul>
235
235
  :type SignComponents: list of Component
236
- :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
236
+ :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
237
237
  <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
238
238
  <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
239
239
  <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
240
240
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
241
241
 
242
+
243
+
244
+
242
245
  注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
243
246
  :type ApproverIdCardType: str
244
247
  :param _ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
@@ -253,7 +256,7 @@ class ApproverInfo(AbstractModel):
253
256
  注意:
254
257
  `如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信`
255
258
  :type NotifyType: str
256
- :param _ApproverRole: 收据场景设置签署人角色类型, 可以设置如下****类型****:
259
+ :param _ApproverRole: 收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
257
260
  <ul><li> **1** :收款人</li>
258
261
  <li> **2** :开具人</li>
259
262
  <li> **3** :见证人</li></ul>
@@ -3341,6 +3344,8 @@ class CreateBatchQuickSignUrlRequest(AbstractModel):
3341
3344
  注:
3342
3345
  `不指定该值时,默认为签署方自行选择。`
3343
3346
  :type SignTypeSelector: int
3347
+ :param _FlowBatchUrlInfo: 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
3348
+ :type FlowBatchUrlInfo: :class:`tencentcloud.ess.v20201111.models.FlowBatchUrlInfo`
3344
3349
  """
3345
3350
  self._FlowApproverInfo = None
3346
3351
  self._Agent = None
@@ -3351,6 +3356,7 @@ class CreateBatchQuickSignUrlRequest(AbstractModel):
3351
3356
  self._SignatureTypes = None
3352
3357
  self._ApproverSignTypes = None
3353
3358
  self._SignTypeSelector = None
3359
+ self._FlowBatchUrlInfo = None
3354
3360
 
3355
3361
  @property
3356
3362
  def FlowApproverInfo(self):
@@ -3424,6 +3430,14 @@ class CreateBatchQuickSignUrlRequest(AbstractModel):
3424
3430
  def SignTypeSelector(self, SignTypeSelector):
3425
3431
  self._SignTypeSelector = SignTypeSelector
3426
3432
 
3433
+ @property
3434
+ def FlowBatchUrlInfo(self):
3435
+ return self._FlowBatchUrlInfo
3436
+
3437
+ @FlowBatchUrlInfo.setter
3438
+ def FlowBatchUrlInfo(self, FlowBatchUrlInfo):
3439
+ self._FlowBatchUrlInfo = FlowBatchUrlInfo
3440
+
3427
3441
 
3428
3442
  def _deserialize(self, params):
3429
3443
  if params.get("FlowApproverInfo") is not None:
@@ -3441,6 +3455,9 @@ class CreateBatchQuickSignUrlRequest(AbstractModel):
3441
3455
  self._SignatureTypes = params.get("SignatureTypes")
3442
3456
  self._ApproverSignTypes = params.get("ApproverSignTypes")
3443
3457
  self._SignTypeSelector = params.get("SignTypeSelector")
3458
+ if params.get("FlowBatchUrlInfo") is not None:
3459
+ self._FlowBatchUrlInfo = FlowBatchUrlInfo()
3460
+ self._FlowBatchUrlInfo._deserialize(params.get("FlowBatchUrlInfo"))
3444
3461
  memeber_set = set(params.keys())
3445
3462
  for name, value in vars(self).items():
3446
3463
  property_name = name[1:]
@@ -6768,9 +6785,10 @@ class CreateFlowSignUrlRequest(AbstractModel):
6768
6785
 
6769
6786
  def __init__(self):
6770
6787
  r"""
6771
- :param _FlowId: 合同流程ID,为32位字符串。
6772
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
6773
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6788
+ :param _FlowId: 合同流程ID32位字符串。
6789
+
6790
+ 您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
6791
+
6774
6792
  :type FlowId: str
6775
6793
  :param _Operator: 执行本接口操作的员工信息。
6776
6794
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
@@ -6778,23 +6796,27 @@ class CreateFlowSignUrlRequest(AbstractModel):
6778
6796
  :param _Agent: 代理企业和员工的信息。
6779
6797
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6780
6798
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6781
- :param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverNameApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
6799
+ :param _FlowApproverInfos: 流程签署人列表中,结构体的ApproverNameApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName
6800
+
6801
+ 注:
6802
+ 1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。
6803
+ 2. 生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。
6804
+
6782
6805
 
6783
- 注:
6784
- `1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
6785
- `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
6786
6806
  :type FlowApproverInfos: list of FlowCreateApprover
6787
6807
  :param _Organization: 机构信息,暂未开放
6788
6808
  :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
6789
6809
  :param _JumpUrl: 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
6790
6810
 
6791
6811
  :type JumpUrl: str
6792
- :param _UrlType: 链接类型,支持指定以下类型
6793
- <ul><li>0 : 签署链接 (默认值)</li>
6794
- <li>1 : 预览链接</li></ul>
6795
- 注:
6796
- `1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
6797
- `2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
6812
+ :param _UrlType: 链接类型支持以下指定类型:
6813
+
6814
+ <ul><li><b>0</b>: 签署链接(默认值),进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接,进入后可以预览合同当前的样子。</li></ul>
6815
+
6816
+ 注:
6817
+
6818
+ 1. 当指定链接类型为1时,链接为预览链接,打开链接后无法进行签署操作,仅支持预览和查看当前合同状态。
6819
+ 2. 如需生成发起方预览链接,则签署方信息应传空,即FlowApproverInfos传空或者不传。
6798
6820
  :type UrlType: int
6799
6821
  """
6800
6822
  self._FlowId = None
@@ -9162,6 +9184,8 @@ class CreatePrepareFlowRequest(AbstractModel):
9162
9184
  :param _InitiatorComponents: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
9163
9185
 
9164
9186
  :type InitiatorComponents: list of Component
9187
+ :param _FlowDisplayType: 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
9188
+ :type FlowDisplayType: int
9165
9189
  """
9166
9190
  self._Operator = None
9167
9191
  self._ResourceId = None
@@ -9182,6 +9206,7 @@ class CreatePrepareFlowRequest(AbstractModel):
9182
9206
  self._FlowId = None
9183
9207
  self._Agent = None
9184
9208
  self._InitiatorComponents = None
9209
+ self._FlowDisplayType = None
9185
9210
 
9186
9211
  @property
9187
9212
  def Operator(self):
@@ -9335,6 +9360,14 @@ class CreatePrepareFlowRequest(AbstractModel):
9335
9360
  def InitiatorComponents(self, InitiatorComponents):
9336
9361
  self._InitiatorComponents = InitiatorComponents
9337
9362
 
9363
+ @property
9364
+ def FlowDisplayType(self):
9365
+ return self._FlowDisplayType
9366
+
9367
+ @FlowDisplayType.setter
9368
+ def FlowDisplayType(self, FlowDisplayType):
9369
+ self._FlowDisplayType = FlowDisplayType
9370
+
9338
9371
 
9339
9372
  def _deserialize(self, params):
9340
9373
  if params.get("Operator") is not None:
@@ -9376,6 +9409,7 @@ class CreatePrepareFlowRequest(AbstractModel):
9376
9409
  obj = Component()
9377
9410
  obj._deserialize(item)
9378
9411
  self._InitiatorComponents.append(obj)
9412
+ self._FlowDisplayType = params.get("FlowDisplayType")
9379
9413
  memeber_set = set(params.keys())
9380
9414
  for name, value in vars(self).items():
9381
9415
  property_name = name[1:]
@@ -13429,11 +13463,10 @@ class DescribeFlowBriefsRequest(AbstractModel):
13429
13463
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
13430
13464
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
13431
13465
  :param _FlowIds: 查询的合同流程ID列表最多支持100个流程ID。
13432
- 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
13433
13466
 
13434
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
13467
+ 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
13435
13468
 
13436
- [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
13469
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
13437
13470
  :type FlowIds: list of str
13438
13471
  :param _Agent: 代理企业和员工的信息。
13439
13472
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -17619,11 +17652,14 @@ class FlowCreateApprover(AbstractModel):
17619
17652
 
17620
17653
  注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
17621
17654
  :type Deadline: int
17622
- :param _Intention: 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
17655
+ :param _Intention: <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。
17623
17656
 
17624
- 注:
17625
- `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
17626
- `2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
17657
+ 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
17658
+
17659
+ 注意:
17660
+ 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
17661
+ 2. 使用视频认证时,<b>生成H5签署链接必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
17662
+ 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
17627
17663
  :type Intention: :class:`tencentcloud.ess.v20201111.models.Intention`
17628
17664
  """
17629
17665
  self._ApproverType = None
@@ -41,6 +41,7 @@ class EssbasicClient(AbstractClient):
41
41
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
42
42
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
43
43
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
44
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
44
45
 
45
46
  :param request: Request instance for ChannelBatchCancelFlows.
46
47
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelBatchCancelFlowsRequest`
@@ -74,6 +75,7 @@ class EssbasicClient(AbstractClient):
74
75
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
75
76
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
76
77
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
78
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
77
79
 
78
80
  :param request: Request instance for ChannelCancelFlow.
79
81
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCancelFlowRequest`
@@ -156,6 +158,7 @@ class EssbasicClient(AbstractClient):
156
158
  注:
157
159
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
158
160
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
161
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
159
162
 
160
163
  :param request: Request instance for ChannelCreateBatchCancelFlowUrl.
161
164
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchCancelFlowUrlRequest`
@@ -178,15 +181,14 @@ class EssbasicClient(AbstractClient):
178
181
 
179
182
 
180
183
  def ChannelCreateBatchQuickSignUrl(self, request):
181
- """该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
182
- **注意**:
183
- 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。
184
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
185
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
186
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
187
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
184
+ """该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
185
+ **注意:**
186
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
187
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
188
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
189
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
188
190
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
189
- 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
191
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
190
192
 
191
193
  :param request: Request instance for ChannelCreateBatchQuickSignUrl.
192
194
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchQuickSignUrlRequest`
@@ -1674,6 +1676,43 @@ class EssbasicClient(AbstractClient):
1674
1676
  raise TencentCloudSDKException(type(e).__name__, str(e))
1675
1677
 
1676
1678
 
1679
+ def CreateChannelSubOrganizationActive(self, request):
1680
+ """激活或续期子客企业, 在激活状态下,企业可以正常发起合同;在非激活状态下,企业仅能查看和签署合同。
1681
+
1682
+ **1. 激活**:使用一个许可证将子客企业从未激活状态转变为激活状态。**激活状态的有效期为一年,一年后将自动回到未激活状态**。
1683
+
1684
+ **2. 续期**:使用一个许可证将已激活的子客企业的有效期延长一年。只有处于激活状态的子企业才能进行续期操作(**若处于非激活状态,则需先激活**)。您可以使用多个许可证对同一子客企业进行多次续费。
1685
+
1686
+
1687
+ 该接口的效果同:**【企业应用管理】 -> 【子客企业管理】 -> 【激活】或者【续期】**
1688
+
1689
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/cd63761ca6e814c64b4ecf131555b74e.png)
1690
+
1691
+
1692
+ 如果不想调用此接口或者页面点击进行激活或续期,可以在【应用扩展服务】中打开自动激活或续期,在许可证充足的情况下会自动激活或续期子客企业
1693
+
1694
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/2ccb37ef6bde463c15c39fdda789216f.png)
1695
+
1696
+ :param request: Request instance for CreateChannelSubOrganizationActive.
1697
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelSubOrganizationActiveRequest`
1698
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelSubOrganizationActiveResponse`
1699
+
1700
+ """
1701
+ try:
1702
+ params = request._serialize()
1703
+ headers = request.headers
1704
+ body = self.call("CreateChannelSubOrganizationActive", params, headers=headers)
1705
+ response = json.loads(body)
1706
+ model = models.CreateChannelSubOrganizationActiveResponse()
1707
+ model._deserialize(response["Response"])
1708
+ return model
1709
+ except Exception as e:
1710
+ if isinstance(e, TencentCloudSDKException):
1711
+ raise
1712
+ else:
1713
+ raise TencentCloudSDKException(type(e).__name__, str(e))
1714
+
1715
+
1677
1716
  def CreateConsoleLoginUrl(self, request):
1678
1717
  """此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
1679
1718
 
@@ -1710,7 +1749,7 @@ class EssbasicClient(AbstractClient):
1710
1749
  2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
1711
1750
 
1712
1751
  系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
1713
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
1752
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)
1714
1753
 
1715
1754
 
1716
1755
  <font color="red">相关视频指引</font> <br>