tencentcloud-sdk-python 3.0.1382__py2.py3-none-any.whl → 3.0.1384__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.
- tencentcloud/__init__.py +1 -1
- tencentcloud/batch/v20170312/models.py +10 -2
- tencentcloud/cbs/v20170312/cbs_client.py +4 -6
- tencentcloud/cbs/v20170312/errorcodes.py +9 -0
- tencentcloud/cbs/v20170312/models.py +178 -119
- tencentcloud/cdb/v20170320/cdb_client.py +1 -1
- tencentcloud/cdb/v20170320/models.py +44 -4
- tencentcloud/cdwdoris/v20211228/models.py +30 -0
- tencentcloud/cfs/v20190719/cfs_client.py +2 -2
- tencentcloud/cfs/v20190719/models.py +46 -48
- tencentcloud/cfw/v20190904/cfw_client.py +1 -1
- tencentcloud/cfw/v20190904/models.py +2 -2
- tencentcloud/cvm/v20170312/models.py +60 -40
- tencentcloud/cynosdb/v20190107/models.py +286 -4
- tencentcloud/dnspod/v20210323/dnspod_client.py +1 -1
- tencentcloud/dnspod/v20210323/errorcodes.py +3 -0
- tencentcloud/dnspod/v20210323/models.py +104 -106
- tencentcloud/domain/v20180808/errorcodes.py +3 -0
- tencentcloud/domain/v20180808/models.py +10 -12
- tencentcloud/emr/v20190103/models.py +15 -0
- tencentcloud/es/v20180416/models.py +87 -0
- tencentcloud/ess/v20201111/errorcodes.py +9 -0
- tencentcloud/ess/v20201111/ess_client.py +25 -0
- tencentcloud/ess/v20201111/models.py +237 -26
- tencentcloud/essbasic/v20210526/errorcodes.py +3 -0
- tencentcloud/essbasic/v20210526/essbasic_client.py +1 -1
- tencentcloud/essbasic/v20210526/models.py +48 -6
- tencentcloud/gs/v20191118/models.py +30 -0
- tencentcloud/hai/v20230812/hai_client.py +9 -7
- tencentcloud/hai/v20230812/models.py +72 -84
- tencentcloud/lke/v20231130/models.py +700 -19
- tencentcloud/lkeap/v20240522/lkeap_client.py +23 -19
- tencentcloud/lkeap/v20240522/models.py +167 -144
- tencentcloud/mps/v20190612/models.py +324 -0
- tencentcloud/mrs/v20200910/models.py +52 -0
- tencentcloud/postgres/v20170312/errorcodes.py +0 -3
- tencentcloud/postgres/v20170312/models.py +0 -282
- tencentcloud/postgres/v20170312/postgres_client.py +0 -75
- tencentcloud/privatedns/v20201028/errorcodes.py +2 -2
- tencentcloud/privatedns/v20201028/models.py +12 -12
- tencentcloud/pts/v20210728/models.py +15 -0
- tencentcloud/ssl/v20191205/errorcodes.py +24 -0
- tencentcloud/ssl/v20191205/models.py +176 -6
- tencentcloud/tcbr/v20220217/models.py +0 -16
- tencentcloud/tdmq/v20200217/errorcodes.py +3 -0
- tencentcloud/teo/v20220901/models.py +81 -13
- tencentcloud/teo/v20220901/teo_client.py +5 -0
- tencentcloud/tke/v20180525/errorcodes.py +18 -0
- tencentcloud/tke/v20180525/models.py +15 -184
- tencentcloud/tke/v20180525/tke_client.py +0 -23
- tencentcloud/tke/v20220501/models.py +115 -2
- tencentcloud/tms/v20201229/errorcodes.py +3 -0
- tencentcloud/tms/v20201229/models.py +36 -4
- tencentcloud/vpc/v20170312/errorcodes.py +15 -0
- tencentcloud/vpc/v20170312/models.py +18 -18
- tencentcloud/vpc/v20170312/vpc_client.py +1 -1
- tencentcloud/waf/v20180125/models.py +120 -32
- {tencentcloud_sdk_python-3.0.1382.dist-info → tencentcloud_sdk_python-3.0.1384.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python-3.0.1382.dist-info → tencentcloud_sdk_python-3.0.1384.dist-info}/RECORD +62 -62
- {tencentcloud_sdk_python-3.0.1382.dist-info → tencentcloud_sdk_python-3.0.1384.dist-info}/LICENSE +0 -0
- {tencentcloud_sdk_python-3.0.1382.dist-info → tencentcloud_sdk_python-3.0.1384.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python-3.0.1382.dist-info → tencentcloud_sdk_python-3.0.1384.dist-info}/top_level.txt +0 -0
@@ -300,9 +300,9 @@ class ApproverInfo(AbstractModel):
|
|
300
300
|
|
301
301
|
注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
|
302
302
|
:type ApproverRoleName: str
|
303
|
-
:param _VerifyChannel: <font
|
303
|
+
:param _VerifyChannel: <font color="red">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别
|
304
304
|
|
305
|
-
注:
|
305
|
+
注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
|
306
306
|
:type VerifyChannel: list of str
|
307
307
|
:param _PreReadTime: 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
|
308
308
|
|
@@ -567,9 +567,9 @@ class ApproverInfo(AbstractModel):
|
|
567
567
|
|
568
568
|
@property
|
569
569
|
def VerifyChannel(self):
|
570
|
-
"""<font
|
570
|
+
"""<font color="red">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别
|
571
571
|
|
572
|
-
注:
|
572
|
+
注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
|
573
573
|
:rtype: list of str
|
574
574
|
"""
|
575
575
|
return self._VerifyChannel
|
@@ -5719,7 +5719,7 @@ class CreateDocumentRequest(AbstractModel):
|
|
5719
5719
|
:param _Agent: 代理企业和员工的信息。
|
5720
5720
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
5721
5721
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
5722
|
-
:param _ClientToken:
|
5722
|
+
:param _ClientToken: 该字段已不再使用
|
5723
5723
|
:type ClientToken: str
|
5724
5724
|
"""
|
5725
5725
|
self._Operator = None
|
@@ -5841,7 +5841,7 @@ class CreateDocumentRequest(AbstractModel):
|
|
5841
5841
|
|
5842
5842
|
@property
|
5843
5843
|
def ClientToken(self):
|
5844
|
-
"""
|
5844
|
+
"""该字段已不再使用
|
5845
5845
|
:rtype: str
|
5846
5846
|
"""
|
5847
5847
|
return self._ClientToken
|
@@ -9033,6 +9033,9 @@ class CreateFlowOption(AbstractModel):
|
|
9033
9033
|
:param _SignComponentConfig: 签署控件的配置信息,用在嵌入式发起的页面配置,包括
|
9034
9034
|
- 签署控件 是否默认展示日期.
|
9035
9035
|
:type SignComponentConfig: :class:`tencentcloud.ess.v20201111.models.SignComponentConfig`
|
9036
|
+
:param _ForbidEditWatermark: 是否禁止编辑(展示)水印控件属性
|
9037
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
9038
|
+
:type ForbidEditWatermark: bool
|
9036
9039
|
"""
|
9037
9040
|
self._CanEditFlow = None
|
9038
9041
|
self._CanEditFormField = None
|
@@ -9050,6 +9053,7 @@ class CreateFlowOption(AbstractModel):
|
|
9050
9053
|
self._ShowComponentTypes = None
|
9051
9054
|
self._ResultPageConfig = None
|
9052
9055
|
self._SignComponentConfig = None
|
9056
|
+
self._ForbidEditWatermark = None
|
9053
9057
|
|
9054
9058
|
@property
|
9055
9059
|
def CanEditFlow(self):
|
@@ -9310,6 +9314,18 @@ class CreateFlowOption(AbstractModel):
|
|
9310
9314
|
def SignComponentConfig(self, SignComponentConfig):
|
9311
9315
|
self._SignComponentConfig = SignComponentConfig
|
9312
9316
|
|
9317
|
+
@property
|
9318
|
+
def ForbidEditWatermark(self):
|
9319
|
+
"""是否禁止编辑(展示)水印控件属性
|
9320
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
9321
|
+
:rtype: bool
|
9322
|
+
"""
|
9323
|
+
return self._ForbidEditWatermark
|
9324
|
+
|
9325
|
+
@ForbidEditWatermark.setter
|
9326
|
+
def ForbidEditWatermark(self, ForbidEditWatermark):
|
9327
|
+
self._ForbidEditWatermark = ForbidEditWatermark
|
9328
|
+
|
9313
9329
|
|
9314
9330
|
def _deserialize(self, params):
|
9315
9331
|
self._CanEditFlow = params.get("CanEditFlow")
|
@@ -9335,6 +9351,7 @@ class CreateFlowOption(AbstractModel):
|
|
9335
9351
|
if params.get("SignComponentConfig") is not None:
|
9336
9352
|
self._SignComponentConfig = SignComponentConfig()
|
9337
9353
|
self._SignComponentConfig._deserialize(params.get("SignComponentConfig"))
|
9354
|
+
self._ForbidEditWatermark = params.get("ForbidEditWatermark")
|
9338
9355
|
memeber_set = set(params.keys())
|
9339
9356
|
for name, value in vars(self).items():
|
9340
9357
|
property_name = name[1:]
|
@@ -9495,7 +9512,7 @@ class CreateFlowRequest(AbstractModel):
|
|
9495
9512
|
:param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
9496
9513
|
此合同类型需要跟模板配置的合同类型保持一致。
|
9497
9514
|
:type FlowType: str
|
9498
|
-
:param _ClientToken:
|
9515
|
+
:param _ClientToken: 该字段已不再使用
|
9499
9516
|
:type ClientToken: str
|
9500
9517
|
:param _DeadLine: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
9501
9518
|
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
@@ -9650,7 +9667,7 @@ class CreateFlowRequest(AbstractModel):
|
|
9650
9667
|
|
9651
9668
|
@property
|
9652
9669
|
def ClientToken(self):
|
9653
|
-
"""
|
9670
|
+
"""该字段已不再使用
|
9654
9671
|
:rtype: str
|
9655
9672
|
"""
|
9656
9673
|
return self._ClientToken
|
@@ -13483,7 +13500,7 @@ class CreatePrepareFlowRequest(AbstractModel):
|
|
13483
13500
|
<ul><li> **OPEN**:开启(默认值)</li>
|
13484
13501
|
<li> **CLOSE**:关闭</li></ul>
|
13485
13502
|
:type IntelligentStatus: str
|
13486
|
-
:param _Components:
|
13503
|
+
:param _Components: 该字段已不再使用,请使用InitiatorComponents
|
13487
13504
|
:type Components: :class:`tencentcloud.ess.v20201111.models.Component`
|
13488
13505
|
:param _FlowOption: 发起合同个性化参数
|
13489
13506
|
用于满足创建及页面操作过程中的个性化要求
|
@@ -13521,7 +13538,7 @@ class CreatePrepareFlowRequest(AbstractModel):
|
|
13521
13538
|
:type InitiatorComponents: list of Component
|
13522
13539
|
:param _FlowDisplayType: 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:
|
13523
13540
|
:type FlowDisplayType: int
|
13524
|
-
:param _SignComponentConfig: <font color="red"
|
13541
|
+
:param _SignComponentConfig: <font color="red">此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig</font>
|
13525
13542
|
签署控件的配置信息,用在嵌入式发起的页面配置,
|
13526
13543
|
包括
|
13527
13544
|
|
@@ -13684,7 +13701,7 @@ class CreatePrepareFlowRequest(AbstractModel):
|
|
13684
13701
|
|
13685
13702
|
@property
|
13686
13703
|
def Components(self):
|
13687
|
-
"""
|
13704
|
+
"""该字段已不再使用,请使用InitiatorComponents
|
13688
13705
|
:rtype: :class:`tencentcloud.ess.v20201111.models.Component`
|
13689
13706
|
"""
|
13690
13707
|
return self._Components
|
@@ -13814,7 +13831,7 @@ class CreatePrepareFlowRequest(AbstractModel):
|
|
13814
13831
|
def SignComponentConfig(self):
|
13815
13832
|
warnings.warn("parameter `SignComponentConfig` is deprecated", DeprecationWarning)
|
13816
13833
|
|
13817
|
-
"""<font color="red"
|
13834
|
+
"""<font color="red">此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig</font>
|
13818
13835
|
签署控件的配置信息,用在嵌入式发起的页面配置,
|
13819
13836
|
包括
|
13820
13837
|
|
@@ -13969,15 +13986,13 @@ class CreatePreparedPersonalEsignRequest(AbstractModel):
|
|
13969
13986
|
<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
|
13970
13987
|
<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)</li></ul>
|
13971
13988
|
:type IdCardType: str
|
13972
|
-
:param _SealImage:
|
13973
|
-
注:已废弃
|
13974
|
-
请先通过UploadFiles接口上传文件,获取 FileId
|
13989
|
+
:param _SealImage: 该字段已不再使用
|
13975
13990
|
:type SealImage: str
|
13976
13991
|
:param _SealImageCompress: 是否开启印章图片压缩处理,默认不开启,如需开启请设置为 true。当印章超过 2M 时建议开启,开启后图片的 hash 将发生变化。
|
13977
13992
|
:type SealImageCompress: bool
|
13978
13993
|
:param _Mobile: 手机号码;当需要开通自动签时,该参数必传
|
13979
13994
|
:type Mobile: str
|
13980
|
-
:param _EnableAutoSign:
|
13995
|
+
:param _EnableAutoSign: 该字段已不再使用
|
13981
13996
|
:type EnableAutoSign: bool
|
13982
13997
|
:param _SealColor: 印章颜色(参数ProcessSeal=true时生效)
|
13983
13998
|
默认值:BLACK黑色
|
@@ -14090,9 +14105,7 @@ BLUE 蓝色。
|
|
14090
14105
|
def SealImage(self):
|
14091
14106
|
warnings.warn("parameter `SealImage` is deprecated", DeprecationWarning)
|
14092
14107
|
|
14093
|
-
"""
|
14094
|
-
注:已废弃
|
14095
|
-
请先通过UploadFiles接口上传文件,获取 FileId
|
14108
|
+
"""该字段已不再使用
|
14096
14109
|
:rtype: str
|
14097
14110
|
"""
|
14098
14111
|
return self._SealImage
|
@@ -14127,7 +14140,7 @@ BLUE 蓝色。
|
|
14127
14140
|
|
14128
14141
|
@property
|
14129
14142
|
def EnableAutoSign(self):
|
14130
|
-
"""
|
14143
|
+
"""该字段已不再使用
|
14131
14144
|
:rtype: bool
|
14132
14145
|
"""
|
14133
14146
|
return self._EnableAutoSign
|
@@ -16469,6 +16482,189 @@ class CreateUserMobileChangeUrlResponse(AbstractModel):
|
|
16469
16482
|
self._RequestId = params.get("RequestId")
|
16470
16483
|
|
16471
16484
|
|
16485
|
+
class CreateUserNameChangeUrlRequest(AbstractModel):
|
16486
|
+
"""CreateUserNameChangeUrl请求参数结构体
|
16487
|
+
|
16488
|
+
"""
|
16489
|
+
|
16490
|
+
def __init__(self):
|
16491
|
+
r"""
|
16492
|
+
:param _Operator: 操作人信息
|
16493
|
+
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
16494
|
+
:param _Endpoint: 要跳转的链接类型
|
16495
|
+
|
16496
|
+
<ul>
|
16497
|
+
<li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
|
16498
|
+
<li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
|
16499
|
+
<li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>
|
16500
|
+
</ul>
|
16501
|
+
|
16502
|
+
注:如果不传递,默认值是 <font color="red"> HTTP </font>
|
16503
|
+
:type Endpoint: str
|
16504
|
+
:param _UserData: 在用户完成改名后,其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。
|
16505
|
+
:type UserData: str
|
16506
|
+
"""
|
16507
|
+
self._Operator = None
|
16508
|
+
self._Endpoint = None
|
16509
|
+
self._UserData = None
|
16510
|
+
|
16511
|
+
@property
|
16512
|
+
def Operator(self):
|
16513
|
+
"""操作人信息
|
16514
|
+
:rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
16515
|
+
"""
|
16516
|
+
return self._Operator
|
16517
|
+
|
16518
|
+
@Operator.setter
|
16519
|
+
def Operator(self, Operator):
|
16520
|
+
self._Operator = Operator
|
16521
|
+
|
16522
|
+
@property
|
16523
|
+
def Endpoint(self):
|
16524
|
+
"""要跳转的链接类型
|
16525
|
+
|
16526
|
+
<ul>
|
16527
|
+
<li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
|
16528
|
+
<li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
|
16529
|
+
<li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>
|
16530
|
+
</ul>
|
16531
|
+
|
16532
|
+
注:如果不传递,默认值是 <font color="red"> HTTP </font>
|
16533
|
+
:rtype: str
|
16534
|
+
"""
|
16535
|
+
return self._Endpoint
|
16536
|
+
|
16537
|
+
@Endpoint.setter
|
16538
|
+
def Endpoint(self, Endpoint):
|
16539
|
+
self._Endpoint = Endpoint
|
16540
|
+
|
16541
|
+
@property
|
16542
|
+
def UserData(self):
|
16543
|
+
"""在用户完成改名后,其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。
|
16544
|
+
:rtype: str
|
16545
|
+
"""
|
16546
|
+
return self._UserData
|
16547
|
+
|
16548
|
+
@UserData.setter
|
16549
|
+
def UserData(self, UserData):
|
16550
|
+
self._UserData = UserData
|
16551
|
+
|
16552
|
+
|
16553
|
+
def _deserialize(self, params):
|
16554
|
+
if params.get("Operator") is not None:
|
16555
|
+
self._Operator = UserInfo()
|
16556
|
+
self._Operator._deserialize(params.get("Operator"))
|
16557
|
+
self._Endpoint = params.get("Endpoint")
|
16558
|
+
self._UserData = params.get("UserData")
|
16559
|
+
memeber_set = set(params.keys())
|
16560
|
+
for name, value in vars(self).items():
|
16561
|
+
property_name = name[1:]
|
16562
|
+
if property_name in memeber_set:
|
16563
|
+
memeber_set.remove(property_name)
|
16564
|
+
if len(memeber_set) > 0:
|
16565
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
16566
|
+
|
16567
|
+
|
16568
|
+
|
16569
|
+
class CreateUserNameChangeUrlResponse(AbstractModel):
|
16570
|
+
"""CreateUserNameChangeUrl返回参数结构体
|
16571
|
+
|
16572
|
+
"""
|
16573
|
+
|
16574
|
+
def __init__(self):
|
16575
|
+
r"""
|
16576
|
+
:param _UserVerifyUrl: 腾讯电子签小程序的个人更名链接。
|
16577
|
+
如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
|
16578
|
+
|
16579
|
+
<strong>1.如果EndPoint是APP</strong>:
|
16580
|
+
得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
|
16581
|
+
|
16582
|
+
<strong>2.如果EndPoint是HTTP</strong>:
|
16583
|
+
得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署
|
16584
|
+
|
16585
|
+
<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:
|
16586
|
+
得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署
|
16587
|
+
|
16588
|
+
|
16589
|
+
`注:` <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>
|
16590
|
+
:type UserVerifyUrl: str
|
16591
|
+
:param _ExpireTime: 链接过期时间,为Unix时间戳(单位为秒)。
|
16592
|
+
:type ExpireTime: int
|
16593
|
+
:param _MiniAppId: 小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回
|
16594
|
+
:type MiniAppId: str
|
16595
|
+
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
16596
|
+
:type RequestId: str
|
16597
|
+
"""
|
16598
|
+
self._UserVerifyUrl = None
|
16599
|
+
self._ExpireTime = None
|
16600
|
+
self._MiniAppId = None
|
16601
|
+
self._RequestId = None
|
16602
|
+
|
16603
|
+
@property
|
16604
|
+
def UserVerifyUrl(self):
|
16605
|
+
"""腾讯电子签小程序的个人更名链接。
|
16606
|
+
如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
|
16607
|
+
|
16608
|
+
<strong>1.如果EndPoint是APP</strong>:
|
16609
|
+
得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
|
16610
|
+
|
16611
|
+
<strong>2.如果EndPoint是HTTP</strong>:
|
16612
|
+
得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署
|
16613
|
+
|
16614
|
+
<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:
|
16615
|
+
得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署
|
16616
|
+
|
16617
|
+
|
16618
|
+
`注:` <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>
|
16619
|
+
:rtype: str
|
16620
|
+
"""
|
16621
|
+
return self._UserVerifyUrl
|
16622
|
+
|
16623
|
+
@UserVerifyUrl.setter
|
16624
|
+
def UserVerifyUrl(self, UserVerifyUrl):
|
16625
|
+
self._UserVerifyUrl = UserVerifyUrl
|
16626
|
+
|
16627
|
+
@property
|
16628
|
+
def ExpireTime(self):
|
16629
|
+
"""链接过期时间,为Unix时间戳(单位为秒)。
|
16630
|
+
:rtype: int
|
16631
|
+
"""
|
16632
|
+
return self._ExpireTime
|
16633
|
+
|
16634
|
+
@ExpireTime.setter
|
16635
|
+
def ExpireTime(self, ExpireTime):
|
16636
|
+
self._ExpireTime = ExpireTime
|
16637
|
+
|
16638
|
+
@property
|
16639
|
+
def MiniAppId(self):
|
16640
|
+
"""小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回
|
16641
|
+
:rtype: str
|
16642
|
+
"""
|
16643
|
+
return self._MiniAppId
|
16644
|
+
|
16645
|
+
@MiniAppId.setter
|
16646
|
+
def MiniAppId(self, MiniAppId):
|
16647
|
+
self._MiniAppId = MiniAppId
|
16648
|
+
|
16649
|
+
@property
|
16650
|
+
def RequestId(self):
|
16651
|
+
"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
16652
|
+
:rtype: str
|
16653
|
+
"""
|
16654
|
+
return self._RequestId
|
16655
|
+
|
16656
|
+
@RequestId.setter
|
16657
|
+
def RequestId(self, RequestId):
|
16658
|
+
self._RequestId = RequestId
|
16659
|
+
|
16660
|
+
|
16661
|
+
def _deserialize(self, params):
|
16662
|
+
self._UserVerifyUrl = params.get("UserVerifyUrl")
|
16663
|
+
self._ExpireTime = params.get("ExpireTime")
|
16664
|
+
self._MiniAppId = params.get("MiniAppId")
|
16665
|
+
self._RequestId = params.get("RequestId")
|
16666
|
+
|
16667
|
+
|
16472
16668
|
class CreateUserVerifyUrlRequest(AbstractModel):
|
16473
16669
|
"""CreateUserVerifyUrl请求参数结构体
|
16474
16670
|
|
@@ -22861,10 +23057,15 @@ class EmbedUrlOption(AbstractModel):
|
|
22861
23057
|
|
22862
23058
|
注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**,
|
22863
23059
|
:type SkipUploadFile: bool
|
23060
|
+
:param _ForbidEditWatermark: 是否禁止编辑(展示)水印控件属性
|
23061
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
23062
|
+
|
23063
|
+
:type ForbidEditWatermark: bool
|
22864
23064
|
"""
|
22865
23065
|
self._ShowFlowDetailComponent = None
|
22866
23066
|
self._ShowTemplateComponent = None
|
22867
23067
|
self._SkipUploadFile = None
|
23068
|
+
self._ForbidEditWatermark = None
|
22868
23069
|
|
22869
23070
|
@property
|
22870
23071
|
def ShowFlowDetailComponent(self):
|
@@ -22910,11 +23111,25 @@ class EmbedUrlOption(AbstractModel):
|
|
22910
23111
|
def SkipUploadFile(self, SkipUploadFile):
|
22911
23112
|
self._SkipUploadFile = SkipUploadFile
|
22912
23113
|
|
23114
|
+
@property
|
23115
|
+
def ForbidEditWatermark(self):
|
23116
|
+
"""是否禁止编辑(展示)水印控件属性
|
23117
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
23118
|
+
|
23119
|
+
:rtype: bool
|
23120
|
+
"""
|
23121
|
+
return self._ForbidEditWatermark
|
23122
|
+
|
23123
|
+
@ForbidEditWatermark.setter
|
23124
|
+
def ForbidEditWatermark(self, ForbidEditWatermark):
|
23125
|
+
self._ForbidEditWatermark = ForbidEditWatermark
|
23126
|
+
|
22913
23127
|
|
22914
23128
|
def _deserialize(self, params):
|
22915
23129
|
self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
|
22916
23130
|
self._ShowTemplateComponent = params.get("ShowTemplateComponent")
|
22917
23131
|
self._SkipUploadFile = params.get("SkipUploadFile")
|
23132
|
+
self._ForbidEditWatermark = params.get("ForbidEditWatermark")
|
22918
23133
|
memeber_set = set(params.keys())
|
22919
23134
|
for name, value in vars(self).items():
|
22920
23135
|
property_name = name[1:]
|
@@ -33868,9 +34083,7 @@ class UploadFilesRequest(AbstractModel):
|
|
33868
34083
|
|
33869
34084
|
注: `该参数仅在关键字定位时,需要去除关键字所在的灰框场景下使用。`
|
33870
34085
|
:type CoverRect: bool
|
33871
|
-
:param _CustomIds:
|
33872
|
-
|
33873
|
-
注: `历史遗留问题,已经废弃,调用接口时不用赋值`
|
34086
|
+
:param _CustomIds: 该字段已不再使用
|
33874
34087
|
:type CustomIds: list of str
|
33875
34088
|
:param _FileUrls: 不再使用,上传文件链接数组,最多支持20个URL
|
33876
34089
|
:type FileUrls: str
|
@@ -33965,9 +34178,7 @@ class UploadFilesRequest(AbstractModel):
|
|
33965
34178
|
|
33966
34179
|
@property
|
33967
34180
|
def CustomIds(self):
|
33968
|
-
"""
|
33969
|
-
|
33970
|
-
注: `历史遗留问题,已经废弃,调用接口时不用赋值`
|
34181
|
+
"""该字段已不再使用
|
33971
34182
|
:rtype: list of str
|
33972
34183
|
"""
|
33973
34184
|
return self._CustomIds
|
@@ -449,6 +449,9 @@ OPERATIONDENIED_OUTQUERYLIMIT = 'OperationDenied.OutQueryLimit'
|
|
449
449
|
# 当前企业员工没有开通境外签署能力。
|
450
450
|
OPERATIONDENIED_OVERSEAABILITYNOTOPEN = 'OperationDenied.OverseaAbilityNotOpen'
|
451
451
|
|
452
|
+
# 该用户名下没有可用签名
|
453
|
+
OPERATIONDENIED_PERSONHASNOSIGNATURE = 'OperationDenied.PersonHasNoSignature'
|
454
|
+
|
452
455
|
# 该用户已关闭或者未开启自动签服务
|
453
456
|
OPERATIONDENIED_PERSONNOOPENSERVERSIGN = 'OperationDenied.PersonNoOpenServerSign'
|
454
457
|
|
@@ -3003,7 +3003,7 @@ class EssbasicClient(AbstractClient):
|
|
3003
3003
|
def PrepareFlows(self, request):
|
3004
3004
|
"""该接口 (PrepareFlows) 用于创建待发起文件
|
3005
3005
|
用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
|
3006
|
-
目前该接口只支持B2C,<font color='red'>
|
3006
|
+
目前该接口只支持B2C,<font color='red'> **不建议使用**</font>。
|
3007
3007
|
|
3008
3008
|
:param request: Request instance for PrepareFlows.
|
3009
3009
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.PrepareFlowsRequest`
|
@@ -2593,7 +2593,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
2593
2593
|
:param _FlowApproverInfo: 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
|
2594
2594
|
<ul>
|
2595
2595
|
<li>若为个人参与方:ApproverType:"PERSON"</li>
|
2596
|
-
<li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName
|
2596
|
+
<li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。(如果OrganizationOpenId对应子客企业已经认证激活,则可以省略OrganizationName参数)</li>
|
2597
2597
|
</ul>
|
2598
2598
|
|
2599
2599
|
注:
|
@@ -2671,7 +2671,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
2671
2671
|
"""批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
|
2672
2672
|
<ul>
|
2673
2673
|
<li>若为个人参与方:ApproverType:"PERSON"</li>
|
2674
|
-
<li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName
|
2674
|
+
<li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。(如果OrganizationOpenId对应子客企业已经认证激活,则可以省略OrganizationName参数)</li>
|
2675
2675
|
</ul>
|
2676
2676
|
|
2677
2677
|
注:
|
@@ -5721,7 +5721,7 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
|
|
5721
5721
|
:type FlowId: str
|
5722
5722
|
:param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverType必传。
|
5723
5723
|
若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
|
5724
|
-
若为子客企业签署方则需传OpenId、OrganizationOpenId,
|
5724
|
+
若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)
|
5725
5725
|
|
5726
5726
|
此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:
|
5727
5727
|
1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。
|
@@ -5792,7 +5792,7 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
|
|
5792
5792
|
def FlowApproverInfos(self):
|
5793
5793
|
"""流程签署人列表,其中结构体的ApproverType必传。
|
5794
5794
|
若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
|
5795
|
-
若为子客企业签署方则需传OpenId、OrganizationOpenId,
|
5795
|
+
若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)
|
5796
5796
|
|
5797
5797
|
此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:
|
5798
5798
|
1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。
|
@@ -7104,7 +7104,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
7104
7104
|
:type SealImageCompress: bool
|
7105
7105
|
:param _Mobile: 手机号码;当需要开通自动签时,该参数必传
|
7106
7106
|
:type Mobile: str
|
7107
|
-
:param _EnableAutoSign:
|
7107
|
+
:param _EnableAutoSign: 该字段已不再使用
|
7108
7108
|
:type EnableAutoSign: bool
|
7109
7109
|
:param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减
|
7110
7110
|
:type LicenseType: int
|
@@ -7238,7 +7238,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
7238
7238
|
|
7239
7239
|
@property
|
7240
7240
|
def EnableAutoSign(self):
|
7241
|
-
"""
|
7241
|
+
"""该字段已不再使用
|
7242
7242
|
:rtype: bool
|
7243
7243
|
"""
|
7244
7244
|
return self._EnableAutoSign
|
@@ -15959,6 +15959,9 @@ class CreateFlowOption(AbstractModel):
|
|
15959
15959
|
:param _SignComponentConfig: 签署控件的配置信息,用在嵌入式发起的页面配置,包括
|
15960
15960
|
- 签署控件 是否默认展示日期.
|
15961
15961
|
:type SignComponentConfig: :class:`tencentcloud.essbasic.v20210526.models.SignComponentConfig`
|
15962
|
+
:param _ForbidEditWatermark: 是否禁止编辑(展示)水印控件属性
|
15963
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
15964
|
+
:type ForbidEditWatermark: bool
|
15962
15965
|
"""
|
15963
15966
|
self._CanEditFlow = None
|
15964
15967
|
self._HideShowFlowName = None
|
@@ -15970,6 +15973,7 @@ class CreateFlowOption(AbstractModel):
|
|
15970
15973
|
self._ForbidEditFillComponent = None
|
15971
15974
|
self._SkipUploadFile = None
|
15972
15975
|
self._SignComponentConfig = None
|
15976
|
+
self._ForbidEditWatermark = None
|
15973
15977
|
|
15974
15978
|
@property
|
15975
15979
|
def CanEditFlow(self):
|
@@ -16101,6 +16105,18 @@ class CreateFlowOption(AbstractModel):
|
|
16101
16105
|
def SignComponentConfig(self, SignComponentConfig):
|
16102
16106
|
self._SignComponentConfig = SignComponentConfig
|
16103
16107
|
|
16108
|
+
@property
|
16109
|
+
def ForbidEditWatermark(self):
|
16110
|
+
"""是否禁止编辑(展示)水印控件属性
|
16111
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
16112
|
+
:rtype: bool
|
16113
|
+
"""
|
16114
|
+
return self._ForbidEditWatermark
|
16115
|
+
|
16116
|
+
@ForbidEditWatermark.setter
|
16117
|
+
def ForbidEditWatermark(self, ForbidEditWatermark):
|
16118
|
+
self._ForbidEditWatermark = ForbidEditWatermark
|
16119
|
+
|
16104
16120
|
|
16105
16121
|
def _deserialize(self, params):
|
16106
16122
|
self._CanEditFlow = params.get("CanEditFlow")
|
@@ -16115,6 +16131,7 @@ class CreateFlowOption(AbstractModel):
|
|
16115
16131
|
if params.get("SignComponentConfig") is not None:
|
16116
16132
|
self._SignComponentConfig = SignComponentConfig()
|
16117
16133
|
self._SignComponentConfig._deserialize(params.get("SignComponentConfig"))
|
16134
|
+
self._ForbidEditWatermark = params.get("ForbidEditWatermark")
|
16118
16135
|
memeber_set = set(params.keys())
|
16119
16136
|
for name, value in vars(self).items():
|
16120
16137
|
property_name = name[1:]
|
@@ -20758,10 +20775,14 @@ class EmbedUrlOption(AbstractModel):
|
|
20758
20775
|
|
20759
20776
|
注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**,
|
20760
20777
|
:type SkipUploadFile: str
|
20778
|
+
:param _ForbidEditWatermark: 是否禁止编辑(展示)水印控件属性
|
20779
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
20780
|
+
:type ForbidEditWatermark: bool
|
20761
20781
|
"""
|
20762
20782
|
self._ShowFlowDetailComponent = None
|
20763
20783
|
self._ShowTemplateComponent = None
|
20764
20784
|
self._SkipUploadFile = None
|
20785
|
+
self._ForbidEditWatermark = None
|
20765
20786
|
|
20766
20787
|
@property
|
20767
20788
|
def ShowFlowDetailComponent(self):
|
@@ -20807,11 +20828,24 @@ class EmbedUrlOption(AbstractModel):
|
|
20807
20828
|
def SkipUploadFile(self, SkipUploadFile):
|
20808
20829
|
self._SkipUploadFile = SkipUploadFile
|
20809
20830
|
|
20831
|
+
@property
|
20832
|
+
def ForbidEditWatermark(self):
|
20833
|
+
"""是否禁止编辑(展示)水印控件属性
|
20834
|
+
<ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
|
20835
|
+
:rtype: bool
|
20836
|
+
"""
|
20837
|
+
return self._ForbidEditWatermark
|
20838
|
+
|
20839
|
+
@ForbidEditWatermark.setter
|
20840
|
+
def ForbidEditWatermark(self, ForbidEditWatermark):
|
20841
|
+
self._ForbidEditWatermark = ForbidEditWatermark
|
20842
|
+
|
20810
20843
|
|
20811
20844
|
def _deserialize(self, params):
|
20812
20845
|
self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
|
20813
20846
|
self._ShowTemplateComponent = params.get("ShowTemplateComponent")
|
20814
20847
|
self._SkipUploadFile = params.get("SkipUploadFile")
|
20848
|
+
self._ForbidEditWatermark = params.get("ForbidEditWatermark")
|
20815
20849
|
memeber_set = set(params.keys())
|
20816
20850
|
for name, value in vars(self).items():
|
20817
20851
|
property_name = name[1:]
|
@@ -21002,6 +21036,8 @@ class FillApproverInfo(AbstractModel):
|
|
21002
21036
|
|
21003
21037
|
:type RecipientId: str
|
21004
21038
|
:param _OpenId: 指定企业经办签署人OpenId
|
21039
|
+
|
21040
|
+
注: `签署人OpenId未实名时,需要传入签署人姓名以及手机号码。`
|
21005
21041
|
:type OpenId: str
|
21006
21042
|
:param _ApproverName: 签署人姓名
|
21007
21043
|
:type ApproverName: str
|
@@ -21060,6 +21096,8 @@ class FillApproverInfo(AbstractModel):
|
|
21060
21096
|
@property
|
21061
21097
|
def OpenId(self):
|
21062
21098
|
"""指定企业经办签署人OpenId
|
21099
|
+
|
21100
|
+
注: `签署人OpenId未实名时,需要传入签署人姓名以及手机号码。`
|
21063
21101
|
:rtype: str
|
21064
21102
|
"""
|
21065
21103
|
return self._OpenId
|
@@ -28880,6 +28918,8 @@ class SignUrlInfo(AbstractModel):
|
|
28880
28918
|
:param _FlowGroupId: 合同组签署链接对应的合同组id
|
28881
28919
|
:type FlowGroupId: str
|
28882
28920
|
:param _SignQrcodeUrl: 二维码,在生成动态签署人跳转封面页链接时返回
|
28921
|
+
|
28922
|
+
注:`此二维码下载链接有效期为5分钟,可下载二维码后本地保存。`
|
28883
28923
|
:type SignQrcodeUrl: str
|
28884
28924
|
"""
|
28885
28925
|
self._SignUrl = None
|
@@ -29052,6 +29092,8 @@ class SignUrlInfo(AbstractModel):
|
|
29052
29092
|
@property
|
29053
29093
|
def SignQrcodeUrl(self):
|
29054
29094
|
"""二维码,在生成动态签署人跳转封面页链接时返回
|
29095
|
+
|
29096
|
+
注:`此二维码下载链接有效期为5分钟,可下载二维码后本地保存。`
|
29055
29097
|
:rtype: str
|
29056
29098
|
"""
|
29057
29099
|
return self._SignQrcodeUrl
|