tencentcloud-sdk-python-ess 3.1.189__tar.gz → 3.1.193__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.
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/PKG-INFO +2 -2
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/setup.py +1 -1
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud/__init__.py +1 -1
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud/ess/v20201111/models.py +107 -114
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
- tencentcloud_sdk_python_ess-3.1.193/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
- tencentcloud_sdk_python_ess-3.1.189/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/README.rst +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/setup.cfg +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud/ess/__init__.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud/ess/v20201111/__init__.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud/ess/v20201111/ess_client.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud/ess/v20201111/ess_client_async.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
- {tencentcloud_sdk_python_ess-3.1.189 → tencentcloud_sdk_python_ess-3.1.193}/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.
|
|
3
|
+
Version: 3.1.193
|
|
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.
|
|
18
|
+
Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.193
|
|
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.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common>=3.1.193,<4.0.0"],
|
|
12
12
|
|
|
13
13
|
version=tencentcloud.__version__,
|
|
14
14
|
description='Tencent Cloud Ess SDK for Python',
|
|
@@ -387,7 +387,7 @@ class ApproverInfo(AbstractModel):
|
|
|
387
387
|
|
|
388
388
|
def __init__(self):
|
|
389
389
|
r"""
|
|
390
|
-
:param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C
|
|
390
|
+
:param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下: </p><p><strong>0</strong>:企业</p><p> <strong>1</strong>:个人</p><p> <strong>3</strong>:企业“授权签”注:<code>类型为3(企业“授权签”)时,此接口会默认完成该签署方的签署。“授权签”仅进行盖章操作,不能“授权签”名。</code></p><p> <strong>7</strong>: 个人“授权签”,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code> </p><p><strong>8</strong>:本方企业 PIN 码授权,注:<code>使用前需先完成员工PIN码授权</code> </p><p><strong>9</strong>:他方企业 PIN 码授权,注:<code>使用前需先完成合作方企业PIN码授权</code></p><p> <strong>10</strong>: 个人 PIN 码授权,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
|
|
391
391
|
:type ApproverType: int
|
|
392
392
|
:param _ApproverName: <p>签署方经办人的姓名。<br>经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
|
|
393
393
|
:type ApproverName: str
|
|
@@ -441,6 +441,8 @@ class ApproverInfo(AbstractModel):
|
|
|
441
441
|
:type NotSaveContact: bool
|
|
442
442
|
:param _ApproverEmail: <p>客户指定的邮箱信息</p>
|
|
443
443
|
:type ApproverEmail: str
|
|
444
|
+
:param _PinCode: <h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>企业员工、他方(合作方)企业、个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
445
|
+
:type PinCode: str
|
|
444
446
|
"""
|
|
445
447
|
self._ApproverType = None
|
|
446
448
|
self._ApproverName = None
|
|
@@ -469,10 +471,11 @@ class ApproverInfo(AbstractModel):
|
|
|
469
471
|
self._RegisterInfo = None
|
|
470
472
|
self._NotSaveContact = None
|
|
471
473
|
self._ApproverEmail = None
|
|
474
|
+
self._PinCode = None
|
|
472
475
|
|
|
473
476
|
@property
|
|
474
477
|
def ApproverType(self):
|
|
475
|
-
r"""<p>在指定签署方时,可选择企业B端或个人C
|
|
478
|
+
r"""<p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下: </p><p><strong>0</strong>:企业</p><p> <strong>1</strong>:个人</p><p> <strong>3</strong>:企业“授权签”注:<code>类型为3(企业“授权签”)时,此接口会默认完成该签署方的签署。“授权签”仅进行盖章操作,不能“授权签”名。</code></p><p> <strong>7</strong>: 个人“授权签”,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code> </p><p><strong>8</strong>:本方企业 PIN 码授权,注:<code>使用前需先完成员工PIN码授权</code> </p><p><strong>9</strong>:他方企业 PIN 码授权,注:<code>使用前需先完成合作方企业PIN码授权</code></p><p> <strong>10</strong>: 个人 PIN 码授权,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
|
|
476
479
|
:rtype: int
|
|
477
480
|
"""
|
|
478
481
|
return self._ApproverType
|
|
@@ -767,6 +770,17 @@ class ApproverInfo(AbstractModel):
|
|
|
767
770
|
def ApproverEmail(self, ApproverEmail):
|
|
768
771
|
self._ApproverEmail = ApproverEmail
|
|
769
772
|
|
|
773
|
+
@property
|
|
774
|
+
def PinCode(self):
|
|
775
|
+
r"""<h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>企业员工、他方(合作方)企业、个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
776
|
+
:rtype: str
|
|
777
|
+
"""
|
|
778
|
+
return self._PinCode
|
|
779
|
+
|
|
780
|
+
@PinCode.setter
|
|
781
|
+
def PinCode(self, PinCode):
|
|
782
|
+
self._PinCode = PinCode
|
|
783
|
+
|
|
770
784
|
|
|
771
785
|
def _deserialize(self, params):
|
|
772
786
|
self._ApproverType = params.get("ApproverType")
|
|
@@ -815,6 +829,7 @@ class ApproverInfo(AbstractModel):
|
|
|
815
829
|
self._RegisterInfo._deserialize(params.get("RegisterInfo"))
|
|
816
830
|
self._NotSaveContact = params.get("NotSaveContact")
|
|
817
831
|
self._ApproverEmail = params.get("ApproverEmail")
|
|
832
|
+
self._PinCode = params.get("PinCode")
|
|
818
833
|
memeber_set = set(params.keys())
|
|
819
834
|
for name, value in vars(self).items():
|
|
820
835
|
property_name = name[1:]
|
|
@@ -18019,6 +18034,8 @@ class CreateReleaseFlowRequest(AbstractModel):
|
|
|
18019
18034
|
:type Deadline: int
|
|
18020
18035
|
:param _UserData: <p>调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。</p><p>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
|
|
18021
18036
|
:type UserData: str
|
|
18037
|
+
:param _FlowName: <p>合同名称</p><p>入参限制:如果替换解除协议的签署人中有本企业PIN 码签署人类型,则此字段必填</p>
|
|
18038
|
+
:type FlowName: str
|
|
18022
18039
|
"""
|
|
18023
18040
|
self._Operator = None
|
|
18024
18041
|
self._NeedRelievedFlowId = None
|
|
@@ -18027,6 +18044,7 @@ class CreateReleaseFlowRequest(AbstractModel):
|
|
|
18027
18044
|
self._ReleasedApprovers = None
|
|
18028
18045
|
self._Deadline = None
|
|
18029
18046
|
self._UserData = None
|
|
18047
|
+
self._FlowName = None
|
|
18030
18048
|
|
|
18031
18049
|
@property
|
|
18032
18050
|
def Operator(self):
|
|
@@ -18105,6 +18123,17 @@ class CreateReleaseFlowRequest(AbstractModel):
|
|
|
18105
18123
|
def UserData(self, UserData):
|
|
18106
18124
|
self._UserData = UserData
|
|
18107
18125
|
|
|
18126
|
+
@property
|
|
18127
|
+
def FlowName(self):
|
|
18128
|
+
r"""<p>合同名称</p><p>入参限制:如果替换解除协议的签署人中有本企业PIN 码签署人类型,则此字段必填</p>
|
|
18129
|
+
:rtype: str
|
|
18130
|
+
"""
|
|
18131
|
+
return self._FlowName
|
|
18132
|
+
|
|
18133
|
+
@FlowName.setter
|
|
18134
|
+
def FlowName(self, FlowName):
|
|
18135
|
+
self._FlowName = FlowName
|
|
18136
|
+
|
|
18108
18137
|
|
|
18109
18138
|
def _deserialize(self, params):
|
|
18110
18139
|
if params.get("Operator") is not None:
|
|
@@ -18125,6 +18154,7 @@ class CreateReleaseFlowRequest(AbstractModel):
|
|
|
18125
18154
|
self._ReleasedApprovers.append(obj)
|
|
18126
18155
|
self._Deadline = params.get("Deadline")
|
|
18127
18156
|
self._UserData = params.get("UserData")
|
|
18157
|
+
self._FlowName = params.get("FlowName")
|
|
18128
18158
|
memeber_set = set(params.keys())
|
|
18129
18159
|
for name, value in vars(self).items():
|
|
18130
18160
|
property_name = name[1:]
|
|
@@ -20917,44 +20947,23 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
20917
20947
|
|
|
20918
20948
|
def __init__(self):
|
|
20919
20949
|
r"""
|
|
20920
|
-
:param _Operator:
|
|
20950
|
+
:param _Operator: <p>操作人信息</p>
|
|
20921
20951
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
20922
|
-
:param _Name:
|
|
20952
|
+
:param _Name: <p>要实名的姓名</p>
|
|
20923
20953
|
:type Name: str
|
|
20924
|
-
:param _IdCardNumber:
|
|
20925
|
-
身份证号码如果有x的话,统一传大写X
|
|
20954
|
+
:param _IdCardNumber: <p>要实名的身份证号码,<br>身份证号码如果有x的话,统一传大写X</p>
|
|
20926
20955
|
:type IdCardNumber: str
|
|
20927
|
-
:param _IdCardType:
|
|
20956
|
+
: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>
|
|
20928
20957
|
:type IdCardType: str
|
|
20929
|
-
:param _Mobile:
|
|
20958
|
+
:param _Mobile: <p>要实名的手机号,兼容带+86的格式</p>
|
|
20930
20959
|
:type Mobile: str
|
|
20931
|
-
:param _JumpUrl:
|
|
20932
|
-
链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。
|
|
20933
|
-
|
|
20934
|
-
注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递
|
|
20935
|
-
|
|
20960
|
+
: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>
|
|
20936
20961
|
:type JumpUrl: str
|
|
20937
|
-
:param _Endpoint:
|
|
20938
|
-
|
|
20939
|
-
<ul>
|
|
20940
|
-
<li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
|
|
20941
|
-
<li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
|
|
20942
|
-
<li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>
|
|
20943
|
-
<li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li>
|
|
20944
|
-
<li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li>
|
|
20945
|
-
</ul>
|
|
20946
|
-
|
|
20947
|
-
注:如果不传递,默认值是 <font color="red"> APP </font>
|
|
20962
|
+
: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>
|
|
20948
20963
|
:type Endpoint: str
|
|
20949
|
-
:param _AutoJumpBack:
|
|
20950
|
-
<ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>
|
|
20951
|
-
|
|
20952
|
-
注:
|
|
20953
|
-
1. 该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效
|
|
20954
|
-
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
|
20955
|
-
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
20964
|
+
: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>
|
|
20956
20965
|
:type AutoJumpBack: bool
|
|
20957
|
-
:param _UserData:
|
|
20966
|
+
: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>
|
|
20958
20967
|
:type UserData: str
|
|
20959
20968
|
"""
|
|
20960
20969
|
self._Operator = None
|
|
@@ -20969,7 +20978,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
20969
20978
|
|
|
20970
20979
|
@property
|
|
20971
20980
|
def Operator(self):
|
|
20972
|
-
r"""
|
|
20981
|
+
r"""<p>操作人信息</p>
|
|
20973
20982
|
:rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
20974
20983
|
"""
|
|
20975
20984
|
return self._Operator
|
|
@@ -20980,7 +20989,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
20980
20989
|
|
|
20981
20990
|
@property
|
|
20982
20991
|
def Name(self):
|
|
20983
|
-
r"""
|
|
20992
|
+
r"""<p>要实名的姓名</p>
|
|
20984
20993
|
:rtype: str
|
|
20985
20994
|
"""
|
|
20986
20995
|
return self._Name
|
|
@@ -20991,8 +21000,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
20991
21000
|
|
|
20992
21001
|
@property
|
|
20993
21002
|
def IdCardNumber(self):
|
|
20994
|
-
r"""
|
|
20995
|
-
身份证号码如果有x的话,统一传大写X
|
|
21003
|
+
r"""<p>要实名的身份证号码,<br>身份证号码如果有x的话,统一传大写X</p>
|
|
20996
21004
|
:rtype: str
|
|
20997
21005
|
"""
|
|
20998
21006
|
return self._IdCardNumber
|
|
@@ -21003,7 +21011,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
21003
21011
|
|
|
21004
21012
|
@property
|
|
21005
21013
|
def IdCardType(self):
|
|
21006
|
-
r"""
|
|
21014
|
+
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>
|
|
21007
21015
|
:rtype: str
|
|
21008
21016
|
"""
|
|
21009
21017
|
return self._IdCardType
|
|
@@ -21014,7 +21022,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
21014
21022
|
|
|
21015
21023
|
@property
|
|
21016
21024
|
def Mobile(self):
|
|
21017
|
-
r"""
|
|
21025
|
+
r"""<p>要实名的手机号,兼容带+86的格式</p>
|
|
21018
21026
|
:rtype: str
|
|
21019
21027
|
"""
|
|
21020
21028
|
return self._Mobile
|
|
@@ -21025,11 +21033,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
21025
21033
|
|
|
21026
21034
|
@property
|
|
21027
21035
|
def JumpUrl(self):
|
|
21028
|
-
r"""
|
|
21029
|
-
链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。
|
|
21030
|
-
|
|
21031
|
-
注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递
|
|
21032
|
-
|
|
21036
|
+
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>
|
|
21033
21037
|
:rtype: str
|
|
21034
21038
|
"""
|
|
21035
21039
|
return self._JumpUrl
|
|
@@ -21040,17 +21044,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
21040
21044
|
|
|
21041
21045
|
@property
|
|
21042
21046
|
def Endpoint(self):
|
|
21043
|
-
r"""
|
|
21044
|
-
|
|
21045
|
-
<ul>
|
|
21046
|
-
<li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
|
|
21047
|
-
<li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
|
|
21048
|
-
<li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>
|
|
21049
|
-
<li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li>
|
|
21050
|
-
<li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li>
|
|
21051
|
-
</ul>
|
|
21052
|
-
|
|
21053
|
-
注:如果不传递,默认值是 <font color="red"> APP </font>
|
|
21047
|
+
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>
|
|
21054
21048
|
:rtype: str
|
|
21055
21049
|
"""
|
|
21056
21050
|
return self._Endpoint
|
|
@@ -21061,13 +21055,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
21061
21055
|
|
|
21062
21056
|
@property
|
|
21063
21057
|
def AutoJumpBack(self):
|
|
21064
|
-
r"""
|
|
21065
|
-
<ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>
|
|
21066
|
-
|
|
21067
|
-
注:
|
|
21068
|
-
1. 该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效
|
|
21069
|
-
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
|
21070
|
-
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
21058
|
+
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>
|
|
21071
21059
|
:rtype: bool
|
|
21072
21060
|
"""
|
|
21073
21061
|
return self._AutoJumpBack
|
|
@@ -21078,7 +21066,7 @@ class CreateUserVerifyUrlRequest(AbstractModel):
|
|
|
21078
21066
|
|
|
21079
21067
|
@property
|
|
21080
21068
|
def UserData(self):
|
|
21081
|
-
r"""
|
|
21069
|
+
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>
|
|
21082
21070
|
:rtype: str
|
|
21083
21071
|
"""
|
|
21084
21072
|
return self._UserData
|
|
@@ -21117,31 +21105,11 @@ class CreateUserVerifyUrlResponse(AbstractModel):
|
|
|
21117
21105
|
|
|
21118
21106
|
def __init__(self):
|
|
21119
21107
|
r"""
|
|
21120
|
-
:param _UserVerifyUrl:
|
|
21121
|
-
如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
|
|
21122
|
-
|
|
21123
|
-
<strong>1.如果EndPoint是APP</strong>:
|
|
21124
|
-
得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
|
|
21125
|
-
|
|
21126
|
-
<strong>2.如果EndPoint是HTTP</strong>:
|
|
21127
|
-
得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署
|
|
21128
|
-
|
|
21129
|
-
<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:
|
|
21130
|
-
得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署
|
|
21131
|
-
|
|
21132
|
-
<strong>4.如果EndPoint是H5</strong>:
|
|
21133
|
-
得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署
|
|
21134
|
-
|
|
21135
|
-
<strong>5.如果EndPoint是H5_SHORT_URL</strong>:
|
|
21136
|
-
得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署
|
|
21137
|
-
|
|
21138
|
-
|
|
21139
|
-
`注:` <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>
|
|
21140
|
-
示例值:https://essurl.cn/2n**42Nd
|
|
21108
|
+
:param _UserVerifyUrl: <p>腾讯电子签小程序的实名认证链接。<br>如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。</p><p><strong>1.如果EndPoint是APP</strong>:<br>得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"</p><p><strong>2.如果EndPoint是HTTP</strong>:<br>得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&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&CodeType=xxx&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>
|
|
21141
21109
|
:type UserVerifyUrl: str
|
|
21142
|
-
:param _ExpireTime:
|
|
21110
|
+
:param _ExpireTime: <p>链接过期时间,为Unix时间戳(单位为秒)。</p>
|
|
21143
21111
|
:type ExpireTime: int
|
|
21144
|
-
:param _MiniAppId:
|
|
21112
|
+
:param _MiniAppId: <p>小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回</p>
|
|
21145
21113
|
:type MiniAppId: str
|
|
21146
21114
|
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
21147
21115
|
:type RequestId: str
|
|
@@ -21153,27 +21121,7 @@ class CreateUserVerifyUrlResponse(AbstractModel):
|
|
|
21153
21121
|
|
|
21154
21122
|
@property
|
|
21155
21123
|
def UserVerifyUrl(self):
|
|
21156
|
-
r"""
|
|
21157
|
-
如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
|
|
21158
|
-
|
|
21159
|
-
<strong>1.如果EndPoint是APP</strong>:
|
|
21160
|
-
得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
|
|
21161
|
-
|
|
21162
|
-
<strong>2.如果EndPoint是HTTP</strong>:
|
|
21163
|
-
得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署
|
|
21164
|
-
|
|
21165
|
-
<strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:
|
|
21166
|
-
得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署
|
|
21167
|
-
|
|
21168
|
-
<strong>4.如果EndPoint是H5</strong>:
|
|
21169
|
-
得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署
|
|
21170
|
-
|
|
21171
|
-
<strong>5.如果EndPoint是H5_SHORT_URL</strong>:
|
|
21172
|
-
得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署
|
|
21173
|
-
|
|
21174
|
-
|
|
21175
|
-
`注:` <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>
|
|
21176
|
-
示例值:https://essurl.cn/2n**42Nd
|
|
21124
|
+
r"""<p>腾讯电子签小程序的实名认证链接。<br>如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。</p><p><strong>1.如果EndPoint是APP</strong>:<br>得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"</p><p><strong>2.如果EndPoint是HTTP</strong>:<br>得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&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&CodeType=xxx&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>
|
|
21177
21125
|
:rtype: str
|
|
21178
21126
|
"""
|
|
21179
21127
|
return self._UserVerifyUrl
|
|
@@ -21184,7 +21132,7 @@ class CreateUserVerifyUrlResponse(AbstractModel):
|
|
|
21184
21132
|
|
|
21185
21133
|
@property
|
|
21186
21134
|
def ExpireTime(self):
|
|
21187
|
-
r"""
|
|
21135
|
+
r"""<p>链接过期时间,为Unix时间戳(单位为秒)。</p>
|
|
21188
21136
|
:rtype: int
|
|
21189
21137
|
"""
|
|
21190
21138
|
return self._ExpireTime
|
|
@@ -21195,7 +21143,7 @@ class CreateUserVerifyUrlResponse(AbstractModel):
|
|
|
21195
21143
|
|
|
21196
21144
|
@property
|
|
21197
21145
|
def MiniAppId(self):
|
|
21198
|
-
r"""
|
|
21146
|
+
r"""<p>小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回</p>
|
|
21199
21147
|
:rtype: str
|
|
21200
21148
|
"""
|
|
21201
21149
|
return self._MiniAppId
|
|
@@ -32009,6 +31957,8 @@ class FillApproverInfo(AbstractModel):
|
|
|
32009
31957
|
:type FlowId: str
|
|
32010
31958
|
:param _NotifyType: <p>通知类型:</p><li>当FillApproverType =0,或签场景补充签署人时,指定是否发送或签领取短信</li><li>SMS:开启或签领取短信通知</li><li>NONE:关闭或签领取短信通知</li><li>当NotifyType=NONE时,可调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl" target="_blank" rel="noopener noreferrer">获取跳转至腾讯电子签小程序的签署链接</a>接口生成签署链接来完成或签领取</li>
|
|
32011
31959
|
:type NotifyType: str
|
|
31960
|
+
:param _PinCode: <h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
31961
|
+
:type PinCode: str
|
|
32012
31962
|
"""
|
|
32013
31963
|
self._RecipientId = None
|
|
32014
31964
|
self._ApproverSource = None
|
|
@@ -32020,6 +31970,7 @@ class FillApproverInfo(AbstractModel):
|
|
|
32020
31970
|
self._ApproverIdCardNumber = None
|
|
32021
31971
|
self._FlowId = None
|
|
32022
31972
|
self._NotifyType = None
|
|
31973
|
+
self._PinCode = None
|
|
32023
31974
|
|
|
32024
31975
|
@property
|
|
32025
31976
|
def RecipientId(self):
|
|
@@ -32131,6 +32082,17 @@ class FillApproverInfo(AbstractModel):
|
|
|
32131
32082
|
def NotifyType(self, NotifyType):
|
|
32132
32083
|
self._NotifyType = NotifyType
|
|
32133
32084
|
|
|
32085
|
+
@property
|
|
32086
|
+
def PinCode(self):
|
|
32087
|
+
r"""<h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
32088
|
+
:rtype: str
|
|
32089
|
+
"""
|
|
32090
|
+
return self._PinCode
|
|
32091
|
+
|
|
32092
|
+
@PinCode.setter
|
|
32093
|
+
def PinCode(self, PinCode):
|
|
32094
|
+
self._PinCode = PinCode
|
|
32095
|
+
|
|
32134
32096
|
|
|
32135
32097
|
def _deserialize(self, params):
|
|
32136
32098
|
self._RecipientId = params.get("RecipientId")
|
|
@@ -32143,6 +32105,7 @@ class FillApproverInfo(AbstractModel):
|
|
|
32143
32105
|
self._ApproverIdCardNumber = params.get("ApproverIdCardNumber")
|
|
32144
32106
|
self._FlowId = params.get("FlowId")
|
|
32145
32107
|
self._NotifyType = params.get("NotifyType")
|
|
32108
|
+
self._PinCode = params.get("PinCode")
|
|
32146
32109
|
memeber_set = set(params.keys())
|
|
32147
32110
|
for name, value in vars(self).items():
|
|
32148
32111
|
property_name = name[1:]
|
|
@@ -33101,7 +33064,7 @@ class FlowCreateApprover(AbstractModel):
|
|
|
33101
33064
|
|
|
33102
33065
|
def __init__(self):
|
|
33103
33066
|
r"""
|
|
33104
|
-
:param _ApproverType: <p
|
|
33067
|
+
:param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下: </p><p><strong>0</strong>:企业</p><p> <strong>1</strong>:个人</p><p> <strong>3</strong>:企业“授权签”注:<code>类型为3(企业“授权签”)时,此接口会默认完成该签署方的签署。“授权签”仅进行盖章操作,不能“授权签”名。</code></p><p> <strong>7</strong>: 个人“授权签”,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code> </p><p><strong>8</strong>:本方企业 PIN 码授权,注:<code>使用前需先完成员工PIN码授权</code> </p><p><strong>9</strong>:他方企业 PIN 码授权,注:<code>使用前需先完成合作方企业PIN码授权</code></p><p> <strong>10</strong>: 个人 PIN 码授权,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
|
|
33105
33068
|
:type ApproverType: int
|
|
33106
33069
|
:param _OrganizationName: <p>组织机构名称。请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号(),请使用中文括号()代替。注: <code>当approverType=0(企业签署方) 或 approverType=3(企业“授权签”)时,必须指定</code></p>
|
|
33107
33070
|
:type OrganizationName: str
|
|
@@ -33163,6 +33126,8 @@ class FlowCreateApprover(AbstractModel):
|
|
|
33163
33126
|
:type NotSaveContact: bool
|
|
33164
33127
|
:param _ApproverEmail: <p>客户指定的邮箱信息</p>
|
|
33165
33128
|
:type ApproverEmail: str
|
|
33129
|
+
:param _PinCode: <h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>企业员工、他方(合作方)企业、个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
33130
|
+
:type PinCode: str
|
|
33166
33131
|
"""
|
|
33167
33132
|
self._ApproverType = None
|
|
33168
33133
|
self._OrganizationName = None
|
|
@@ -33195,10 +33160,11 @@ class FlowCreateApprover(AbstractModel):
|
|
|
33195
33160
|
self._SignEndpoints = None
|
|
33196
33161
|
self._NotSaveContact = None
|
|
33197
33162
|
self._ApproverEmail = None
|
|
33163
|
+
self._PinCode = None
|
|
33198
33164
|
|
|
33199
33165
|
@property
|
|
33200
33166
|
def ApproverType(self):
|
|
33201
|
-
r"""<p
|
|
33167
|
+
r"""<p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下: </p><p><strong>0</strong>:企业</p><p> <strong>1</strong>:个人</p><p> <strong>3</strong>:企业“授权签”注:<code>类型为3(企业“授权签”)时,此接口会默认完成该签署方的签署。“授权签”仅进行盖章操作,不能“授权签”名。</code></p><p> <strong>7</strong>: 个人“授权签”,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code> </p><p><strong>8</strong>:本方企业 PIN 码授权,注:<code>使用前需先完成员工PIN码授权</code> </p><p><strong>9</strong>:他方企业 PIN 码授权,注:<code>使用前需先完成合作方企业PIN码授权</code></p><p> <strong>10</strong>: 个人 PIN 码授权,适用于个人“授权签”场景。注: <code>个人“授权签”场景为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
|
|
33202
33168
|
:rtype: int
|
|
33203
33169
|
"""
|
|
33204
33170
|
return self._ApproverType
|
|
@@ -33541,6 +33507,17 @@ class FlowCreateApprover(AbstractModel):
|
|
|
33541
33507
|
def ApproverEmail(self, ApproverEmail):
|
|
33542
33508
|
self._ApproverEmail = ApproverEmail
|
|
33543
33509
|
|
|
33510
|
+
@property
|
|
33511
|
+
def PinCode(self):
|
|
33512
|
+
r"""<h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>企业员工、他方(合作方)企业、个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
33513
|
+
:rtype: str
|
|
33514
|
+
"""
|
|
33515
|
+
return self._PinCode
|
|
33516
|
+
|
|
33517
|
+
@PinCode.setter
|
|
33518
|
+
def PinCode(self, PinCode):
|
|
33519
|
+
self._PinCode = PinCode
|
|
33520
|
+
|
|
33544
33521
|
|
|
33545
33522
|
def _deserialize(self, params):
|
|
33546
33523
|
self._ApproverType = params.get("ApproverType")
|
|
@@ -33590,6 +33567,7 @@ class FlowCreateApprover(AbstractModel):
|
|
|
33590
33567
|
self._SignEndpoints = params.get("SignEndpoints")
|
|
33591
33568
|
self._NotSaveContact = params.get("NotSaveContact")
|
|
33592
33569
|
self._ApproverEmail = params.get("ApproverEmail")
|
|
33570
|
+
self._PinCode = params.get("PinCode")
|
|
33593
33571
|
memeber_set = set(params.keys())
|
|
33594
33572
|
for name, value in vars(self).items():
|
|
33595
33573
|
property_name = name[1:]
|
|
@@ -38646,7 +38624,7 @@ class NeedReviewApproverInfo(AbstractModel):
|
|
|
38646
38624
|
:type ApproverIdCardType: str
|
|
38647
38625
|
:param _ApproverIdCardNumber: <p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
38648
38626
|
:type ApproverIdCardNumber: str
|
|
38649
|
-
:param _OrganizationName: <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br
|
|
38627
|
+
:param _OrganizationName: <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方, 则企业名称必填。</p>
|
|
38650
38628
|
:type OrganizationName: str
|
|
38651
38629
|
"""
|
|
38652
38630
|
self._ApproverType = None
|
|
@@ -38713,7 +38691,7 @@ class NeedReviewApproverInfo(AbstractModel):
|
|
|
38713
38691
|
|
|
38714
38692
|
@property
|
|
38715
38693
|
def OrganizationName(self):
|
|
38716
|
-
r"""<p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br
|
|
38694
|
+
r"""<p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方, 则企业名称必填。</p>
|
|
38717
38695
|
:rtype: str
|
|
38718
38696
|
"""
|
|
38719
38697
|
return self._OrganizationName
|
|
@@ -42484,7 +42462,7 @@ class ReleasedApprover(AbstractModel):
|
|
|
42484
42462
|
:type Mobile: str
|
|
42485
42463
|
:param _RelievedApproverReceiptId: <p>要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br></p>
|
|
42486
42464
|
:type RelievedApproverReceiptId: str
|
|
42487
|
-
:param _ApproverType: <p>指定签署人类型,目前仅支持<ul><li> <strong>ORGANIZATION</strong>:企业(默认值)</li><li> <strong>ENTERPRISESERVER</strong
|
|
42465
|
+
:param _ApproverType: <p>指定签署人类型,目前仅支持<ul><li> <strong>ORGANIZATION</strong>:企业(默认值)</li><li> <strong>ENTERPRISESERVER</strong>:本方企业“授权签”</li><li> <strong>ORGANIZATION_PIN_CODE_SIGN</strong>:本方企业PIN码签署</li></ul></p>
|
|
42488
42466
|
:type ApproverType: str
|
|
42489
42467
|
:param _ApproverSignComponentType: <p>签署控件类型,支持自定义企业签署方的签署控件类型</p><ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li><li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
|
|
42490
42468
|
:type ApproverSignComponentType: str
|
|
@@ -42494,6 +42472,8 @@ class ReleasedApprover(AbstractModel):
|
|
|
42494
42472
|
:type ApproverSignSealId: str
|
|
42495
42473
|
:param _RelievedApproverRecipientId: <p>要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br></p>
|
|
42496
42474
|
:type RelievedApproverRecipientId: str
|
|
42475
|
+
:param _PinCode: <h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>企业员工、他方(合作方)企业、个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
42476
|
+
:type PinCode: str
|
|
42497
42477
|
"""
|
|
42498
42478
|
self._Name = None
|
|
42499
42479
|
self._Mobile = None
|
|
@@ -42503,6 +42483,7 @@ class ReleasedApprover(AbstractModel):
|
|
|
42503
42483
|
self._ApproverSignRole = None
|
|
42504
42484
|
self._ApproverSignSealId = None
|
|
42505
42485
|
self._RelievedApproverRecipientId = None
|
|
42486
|
+
self._PinCode = None
|
|
42506
42487
|
|
|
42507
42488
|
@property
|
|
42508
42489
|
def Name(self):
|
|
@@ -42543,7 +42524,7 @@ class ReleasedApprover(AbstractModel):
|
|
|
42543
42524
|
|
|
42544
42525
|
@property
|
|
42545
42526
|
def ApproverType(self):
|
|
42546
|
-
r"""<p>指定签署人类型,目前仅支持<ul><li> <strong>ORGANIZATION</strong>:企业(默认值)</li><li> <strong>ENTERPRISESERVER</strong
|
|
42527
|
+
r"""<p>指定签署人类型,目前仅支持<ul><li> <strong>ORGANIZATION</strong>:企业(默认值)</li><li> <strong>ENTERPRISESERVER</strong>:本方企业“授权签”</li><li> <strong>ORGANIZATION_PIN_CODE_SIGN</strong>:本方企业PIN码签署</li></ul></p>
|
|
42547
42528
|
:rtype: str
|
|
42548
42529
|
"""
|
|
42549
42530
|
return self._ApproverType
|
|
@@ -42596,6 +42577,17 @@ class ReleasedApprover(AbstractModel):
|
|
|
42596
42577
|
def RelievedApproverRecipientId(self, RelievedApproverRecipientId):
|
|
42597
42578
|
self._RelievedApproverRecipientId = RelievedApproverRecipientId
|
|
42598
42579
|
|
|
42580
|
+
@property
|
|
42581
|
+
def PinCode(self):
|
|
42582
|
+
r"""<h2>PinCode计算规则</h2> <p>当使用 PIN 码授权签进行身份验证时,需要按以下规则生成 <code>PinCode</code>。</p> <h3 id="计算公式">计算公式</h3> <pre><code class="language-text">PinCode = HMAC_SHA256(SHA256(PIN 码),合同名称) </code></pre> <p>示例: PinCode = HMAC_SHA256(SHA256("v0ZIwH8lRDLsWRHJWJT7PR05FoXdl4S2"),"给张三的入职合同")</p> <table> <thead> <tr> <th>参数</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td><strong>PIN 码</strong></td> <td>企业员工、他方(合作方)企业、个人授权的 PIN 码</td> </tr> <tr> <td><strong>合同名称</strong></td> <td>签署流程名称,即FlowName,<font color="#FF0000">需去除合同名称前后空格后再进行计算</font></td> </tr> </tbody> </table>
|
|
42583
|
+
:rtype: str
|
|
42584
|
+
"""
|
|
42585
|
+
return self._PinCode
|
|
42586
|
+
|
|
42587
|
+
@PinCode.setter
|
|
42588
|
+
def PinCode(self, PinCode):
|
|
42589
|
+
self._PinCode = PinCode
|
|
42590
|
+
|
|
42599
42591
|
|
|
42600
42592
|
def _deserialize(self, params):
|
|
42601
42593
|
self._Name = params.get("Name")
|
|
@@ -42606,6 +42598,7 @@ class ReleasedApprover(AbstractModel):
|
|
|
42606
42598
|
self._ApproverSignRole = params.get("ApproverSignRole")
|
|
42607
42599
|
self._ApproverSignSealId = params.get("ApproverSignSealId")
|
|
42608
42600
|
self._RelievedApproverRecipientId = params.get("RelievedApproverRecipientId")
|
|
42601
|
+
self._PinCode = params.get("PinCode")
|
|
42609
42602
|
memeber_set = set(params.keys())
|
|
42610
42603
|
for name, value in vars(self).items():
|
|
42611
42604
|
property_name = name[1:]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: tencentcloud-sdk-python-ess
|
|
3
|
-
Version: 3.1.
|
|
3
|
+
Version: 3.1.193
|
|
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.
|
|
18
|
+
Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.193
|
|
19
19
|
|
|
20
20
|
============================
|
|
21
21
|
Tencent Cloud SDK for Python
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
tencentcloud-sdk-python-common<4.0.0,>=3.1.193
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
tencentcloud-sdk-python-common<4.0.0,>=3.1.189
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|