tencentcloud-sdk-python-essbasic 3.0.1264__tar.gz → 3.0.1276__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-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/PKG-INFO +3 -3
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/setup.cfg +0 -1
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/setup.py +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/__init__.py +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20210526/essbasic_client.py +38 -13
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20210526/models.py +441 -64
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +3 -3
- tencentcloud-sdk-python-essbasic-3.0.1276/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
- tencentcloud-sdk-python-essbasic-3.0.1264/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/README.rst +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20201222/models.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
{tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/PKG-INFO
RENAMED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
Metadata-Version: 1.
|
|
1
|
+
Metadata-Version: 1.2
|
|
2
2
|
Name: tencentcloud-sdk-python-essbasic
|
|
3
|
-
Version: 3.0.
|
|
3
|
+
Version: 3.0.1276
|
|
4
4
|
Summary: Tencent Cloud Essbasic SDK for Python
|
|
5
5
|
Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
|
|
6
6
|
Author: Tencent Cloud
|
|
7
|
-
|
|
7
|
+
Maintainer-email: tencentcloudapi@tencent.com
|
|
8
8
|
License: Apache License 2.0
|
|
9
9
|
Description: ============================
|
|
10
10
|
Tencent Cloud SDK for Python
|
{tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/setup.py
RENAMED
|
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
|
|
|
8
8
|
|
|
9
9
|
setup(
|
|
10
10
|
name='tencentcloud-sdk-python-essbasic',
|
|
11
|
-
install_requires=["tencentcloud-sdk-python-common==3.0.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common==3.0.1276"],
|
|
12
12
|
version=tencentcloud.__version__,
|
|
13
13
|
description='Tencent Cloud Essbasic SDK for Python',
|
|
14
14
|
long_description=open('README.rst').read(),
|
|
@@ -181,11 +181,10 @@ class EssbasicClient(AbstractClient):
|
|
|
181
181
|
|
|
182
182
|
|
|
183
183
|
def ChannelCreateBatchQuickSignUrl(self, request):
|
|
184
|
-
"""
|
|
184
|
+
"""该接口用于发起合同后,生成个人/企业用户的批量待办链接。
|
|
185
185
|
**注意:**
|
|
186
|
-
1.
|
|
187
|
-
2.
|
|
188
|
-
3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
186
|
+
1. 该接口可生成签署人的批量、合同组签署/查看链接 。
|
|
187
|
+
2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
189
188
|
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
190
189
|
跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
191
190
|
6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
@@ -1236,12 +1235,32 @@ class EssbasicClient(AbstractClient):
|
|
|
1236
1235
|
|
|
1237
1236
|
|
|
1238
1237
|
def ChannelDescribeFlowComponents(self, request):
|
|
1239
|
-
"""
|
|
1238
|
+
"""您可以通过合同流程ID查询相关的<font color="red"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。
|
|
1239
|
+
|
|
1240
|
+
无论是<font color="red"><b>发起方还是签署方</b></font>填写的控件,均包含在查询结果中。
|
|
1241
|
+
|
|
1242
|
+

|
|
1243
|
+
### 2. 哪些控件会出现在结果里边?
|
|
1244
|
+
**A.不返回的控件类型:**
|
|
1245
|
+
- 动态表格
|
|
1246
|
+
- 附件控件
|
|
1247
|
+
- 水印控件
|
|
1248
|
+
|
|
1249
|
+
**B.返回的控件类型:**
|
|
1250
|
+
- 单行文本
|
|
1251
|
+
- 多行文本
|
|
1252
|
+
- 勾选框控件
|
|
1253
|
+
- 数字控件
|
|
1254
|
+
- 日期控件
|
|
1255
|
+
- 图片控件(图片下载地址)
|
|
1256
|
+
- 邮箱控件
|
|
1257
|
+
- 地址控件
|
|
1258
|
+
- 学历控件
|
|
1259
|
+
- 性别控件
|
|
1260
|
+
- 省市区控件
|
|
1261
|
+
|
|
1262
|
+
### 3.怎么授权?
|
|
1240
1263
|
|
|
1241
|
-
**注意**: `附件控件不会出现在结果列表中`
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
**授权**:
|
|
1245
1264
|
此接口需要授权, 有两种开通权限的途径
|
|
1246
1265
|
|
|
1247
1266
|
**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
|
|
@@ -2061,14 +2080,19 @@ class EssbasicClient(AbstractClient):
|
|
|
2061
2080
|
|
|
2062
2081
|
|
|
2063
2082
|
def CreatePartnerAutoSignAuthUrl(self, request):
|
|
2064
|
-
"""
|
|
2065
|
-
该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
|
|
2083
|
+
"""创建一个用于他方自动签授权的链接(可选择他方授权或我方授权)。通过这个链接,合作方企业可以直接进入小程序,进行自动签授权操作。
|
|
2066
2084
|
|
|
2085
|
+
如果授权企业尚未开通企业自动签功能,该链接还将引导他们首先开通本企业的自动签服务
|
|
2067
2086
|
|
|
2068
2087
|
|
|
2069
2088
|
注:
|
|
2070
2089
|
1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
|
|
2071
2090
|
2. 已经在授权中或者授权成功的企业,无法重复授权
|
|
2091
|
+
3. 授权企业和被授权企业必须都是已认证企业
|
|
2092
|
+
4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。
|
|
2093
|
+
|
|
2094
|
+
**该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**
|
|
2095
|
+

|
|
2072
2096
|
|
|
2073
2097
|
:param request: Request instance for CreatePartnerAutoSignAuthUrl.
|
|
2074
2098
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.CreatePartnerAutoSignAuthUrlRequest`
|
|
@@ -2100,7 +2124,7 @@ class EssbasicClient(AbstractClient):
|
|
|
2100
2124
|
注:
|
|
2101
2125
|
<ul>
|
|
2102
2126
|
<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
|
|
2103
|
-
<li
|
|
2127
|
+
<li>专为电子处方单(医疗自动签)特定场景使用。在使用前,请务必与您的客户经理联系以确认已经开通电子处方单功能 </li>
|
|
2104
2128
|
</ul>
|
|
2105
2129
|
|
|
2106
2130
|
:param request: Request instance for CreatePersonAuthCertificateImage.
|
|
@@ -2548,7 +2572,8 @@ class EssbasicClient(AbstractClient):
|
|
|
2548
2572
|
|
|
2549
2573
|
def DescribeUsage(self, request):
|
|
2550
2574
|
"""此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
|
|
2551
|
-
|
|
2575
|
+
|
|
2576
|
+
<font color="red">此接口即将下线, 请使用新接口</font> [查询渠道计费消耗情况](https://qian.tencent.com/developers/partnerApis/fee/ChannelDescribeBillUsageDetail)
|
|
2552
2577
|
|
|
2553
2578
|
注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
2554
2579
|
|
|
@@ -2360,10 +2360,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2360
2360
|
def __init__(self):
|
|
2361
2361
|
r"""
|
|
2362
2362
|
:param _FlowApproverInfo: 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
|
|
2363
|
+
<ul>
|
|
2364
|
+
<li>若为个人参与方:ApproverType:"PERSON"</li>
|
|
2365
|
+
<li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>
|
|
2366
|
+
</ul>
|
|
2367
|
+
|
|
2363
2368
|
注:
|
|
2364
|
-
`1.
|
|
2365
|
-
`2.
|
|
2366
|
-
`3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
2369
|
+
`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
|
|
2370
|
+
`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
2367
2371
|
:type FlowApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
|
|
2368
2372
|
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2369
2373
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
@@ -2384,7 +2388,9 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2384
2388
|
注:
|
|
2385
2389
|
<ul><li>默认情况下,签名类型为手写签名</li>
|
|
2386
2390
|
<li>您可以传递多种值,表示可用多种签名类型。</li>
|
|
2387
|
-
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li
|
|
2391
|
+
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
|
|
2392
|
+
<li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>
|
|
2393
|
+
</ul>
|
|
2388
2394
|
:type SignatureTypes: list of int
|
|
2389
2395
|
:param _ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值:
|
|
2390
2396
|
<ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
|
|
@@ -2401,10 +2407,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2401
2407
|
`不指定该值时,默认为签署方自行选择。`
|
|
2402
2408
|
:type SignTypeSelector: int
|
|
2403
2409
|
:param _FlowBatchUrlInfo: 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
|
|
2410
|
+
|
|
2411
|
+
注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
|
|
2404
2412
|
:type FlowBatchUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
|
|
2405
2413
|
:param _Intention: <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 注意: 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
|
|
2406
2414
|
:type Intention: :class:`tencentcloud.essbasic.v20210526.models.Intention`
|
|
2407
2415
|
:param _CacheApproverInfo: 缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
|
|
2416
|
+
|
|
2417
|
+
注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
|
|
2408
2418
|
:type CacheApproverInfo: bool
|
|
2409
2419
|
"""
|
|
2410
2420
|
self._FlowApproverInfo = None
|
|
@@ -2422,10 +2432,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2422
2432
|
@property
|
|
2423
2433
|
def FlowApproverInfo(self):
|
|
2424
2434
|
"""批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
|
|
2435
|
+
<ul>
|
|
2436
|
+
<li>若为个人参与方:ApproverType:"PERSON"</li>
|
|
2437
|
+
<li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>
|
|
2438
|
+
</ul>
|
|
2439
|
+
|
|
2425
2440
|
注:
|
|
2426
|
-
`1.
|
|
2427
|
-
`2.
|
|
2428
|
-
`3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
2441
|
+
`1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
|
|
2442
|
+
`2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
|
|
2429
2443
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
|
|
2430
2444
|
"""
|
|
2431
2445
|
return self._FlowApproverInfo
|
|
@@ -2491,7 +2505,9 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2491
2505
|
注:
|
|
2492
2506
|
<ul><li>默认情况下,签名类型为手写签名</li>
|
|
2493
2507
|
<li>您可以传递多种值,表示可用多种签名类型。</li>
|
|
2494
|
-
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li
|
|
2508
|
+
<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
|
|
2509
|
+
<li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>
|
|
2510
|
+
</ul>
|
|
2495
2511
|
:rtype: list of int
|
|
2496
2512
|
"""
|
|
2497
2513
|
return self._SignatureTypes
|
|
@@ -2535,6 +2551,8 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2535
2551
|
@property
|
|
2536
2552
|
def FlowBatchUrlInfo(self):
|
|
2537
2553
|
"""批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
|
|
2554
|
+
|
|
2555
|
+
注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
|
|
2538
2556
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
|
|
2539
2557
|
"""
|
|
2540
2558
|
return self._FlowBatchUrlInfo
|
|
@@ -2557,6 +2575,8 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
2557
2575
|
@property
|
|
2558
2576
|
def CacheApproverInfo(self):
|
|
2559
2577
|
"""缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
|
|
2578
|
+
|
|
2579
|
+
注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
|
|
2560
2580
|
:rtype: bool
|
|
2561
2581
|
"""
|
|
2562
2582
|
return self._CacheApproverInfo
|
|
@@ -2722,6 +2742,14 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
2722
2742
|
:type OpenId: str
|
|
2723
2743
|
:param _OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId,批签合同经办人为子客企业员工是为必填。
|
|
2724
2744
|
:type OrganizationOpenId: str
|
|
2745
|
+
:param _AutoJumpBack: 签署完成后是否自动回跳
|
|
2746
|
+
<ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
|
|
2747
|
+
|
|
2748
|
+
注:
|
|
2749
|
+
1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
|
|
2750
|
+
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
|
2751
|
+
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
2752
|
+
:type AutoJumpBack: bool
|
|
2725
2753
|
"""
|
|
2726
2754
|
self._Agent = None
|
|
2727
2755
|
self._Name = None
|
|
@@ -2736,6 +2764,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
2736
2764
|
self._FlowBatchUrlInfo = None
|
|
2737
2765
|
self._OpenId = None
|
|
2738
2766
|
self._OrganizationOpenId = None
|
|
2767
|
+
self._AutoJumpBack = None
|
|
2739
2768
|
|
|
2740
2769
|
@property
|
|
2741
2770
|
def Agent(self):
|
|
@@ -2928,6 +2957,23 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
2928
2957
|
def OrganizationOpenId(self, OrganizationOpenId):
|
|
2929
2958
|
self._OrganizationOpenId = OrganizationOpenId
|
|
2930
2959
|
|
|
2960
|
+
@property
|
|
2961
|
+
def AutoJumpBack(self):
|
|
2962
|
+
"""签署完成后是否自动回跳
|
|
2963
|
+
<ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
|
|
2964
|
+
|
|
2965
|
+
注:
|
|
2966
|
+
1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
|
|
2967
|
+
2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
|
2968
|
+
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
2969
|
+
:rtype: bool
|
|
2970
|
+
"""
|
|
2971
|
+
return self._AutoJumpBack
|
|
2972
|
+
|
|
2973
|
+
@AutoJumpBack.setter
|
|
2974
|
+
def AutoJumpBack(self, AutoJumpBack):
|
|
2975
|
+
self._AutoJumpBack = AutoJumpBack
|
|
2976
|
+
|
|
2931
2977
|
|
|
2932
2978
|
def _deserialize(self, params):
|
|
2933
2979
|
if params.get("Agent") is not None:
|
|
@@ -2949,6 +2995,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
2949
2995
|
self._FlowBatchUrlInfo._deserialize(params.get("FlowBatchUrlInfo"))
|
|
2950
2996
|
self._OpenId = params.get("OpenId")
|
|
2951
2997
|
self._OrganizationOpenId = params.get("OrganizationOpenId")
|
|
2998
|
+
self._AutoJumpBack = params.get("AutoJumpBack")
|
|
2952
2999
|
memeber_set = set(params.keys())
|
|
2953
3000
|
for name, value in vars(self).items():
|
|
2954
3001
|
property_name = name[1:]
|
|
@@ -5403,6 +5450,8 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
|
|
|
5403
5450
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
5404
5451
|
:param _ForbidPersonalMultipleSign: 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。
|
|
5405
5452
|
:type ForbidPersonalMultipleSign: bool
|
|
5453
|
+
:param _FlowNameAppendScannerInfo: 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
|
|
5454
|
+
:type FlowNameAppendScannerInfo: bool
|
|
5406
5455
|
"""
|
|
5407
5456
|
self._Agent = None
|
|
5408
5457
|
self._TemplateId = None
|
|
@@ -5416,6 +5465,7 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
|
|
|
5416
5465
|
self._ApproverRestrictions = None
|
|
5417
5466
|
self._Operator = None
|
|
5418
5467
|
self._ForbidPersonalMultipleSign = None
|
|
5468
|
+
self._FlowNameAppendScannerInfo = None
|
|
5419
5469
|
|
|
5420
5470
|
@property
|
|
5421
5471
|
def Agent(self):
|
|
@@ -5571,6 +5621,17 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
|
|
|
5571
5621
|
def ForbidPersonalMultipleSign(self, ForbidPersonalMultipleSign):
|
|
5572
5622
|
self._ForbidPersonalMultipleSign = ForbidPersonalMultipleSign
|
|
5573
5623
|
|
|
5624
|
+
@property
|
|
5625
|
+
def FlowNameAppendScannerInfo(self):
|
|
5626
|
+
"""合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
|
|
5627
|
+
:rtype: bool
|
|
5628
|
+
"""
|
|
5629
|
+
return self._FlowNameAppendScannerInfo
|
|
5630
|
+
|
|
5631
|
+
@FlowNameAppendScannerInfo.setter
|
|
5632
|
+
def FlowNameAppendScannerInfo(self, FlowNameAppendScannerInfo):
|
|
5633
|
+
self._FlowNameAppendScannerInfo = FlowNameAppendScannerInfo
|
|
5634
|
+
|
|
5574
5635
|
|
|
5575
5636
|
def _deserialize(self, params):
|
|
5576
5637
|
if params.get("Agent") is not None:
|
|
@@ -5601,6 +5662,7 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
|
|
|
5601
5662
|
self._Operator = UserInfo()
|
|
5602
5663
|
self._Operator._deserialize(params.get("Operator"))
|
|
5603
5664
|
self._ForbidPersonalMultipleSign = params.get("ForbidPersonalMultipleSign")
|
|
5665
|
+
self._FlowNameAppendScannerInfo = params.get("FlowNameAppendScannerInfo")
|
|
5604
5666
|
memeber_set = set(params.keys())
|
|
5605
5667
|
for name, value in vars(self).items():
|
|
5606
5668
|
property_name = name[1:]
|
|
@@ -6560,14 +6622,13 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
|
|
|
6560
6622
|
:type NeedRelievedFlowId: str
|
|
6561
6623
|
:param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
|
|
6562
6624
|
:type ReliveInfo: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
|
|
6563
|
-
:param _ReleasedApprovers:
|
|
6625
|
+
:param _ReleasedApprovers: 替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
|
|
6564
6626
|
如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
|
|
6565
6627
|
|
|
6566
|
-
|
|
6567
|
-
|
|
6568
|
-
|
|
6569
|
-
<
|
|
6570
|
-
</ul>
|
|
6628
|
+
注:
|
|
6629
|
+
1. 支持更换企业的签署人,不支持更换个人类型的签署人。
|
|
6630
|
+
2. 己方企业支持自动签署,他方企业不支持自动签署。
|
|
6631
|
+
3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。
|
|
6571
6632
|
:type ReleasedApprovers: list of ReleasedApprover
|
|
6572
6633
|
:param _CallbackUrl: 签署完回调url,最大长度1000个字符
|
|
6573
6634
|
:type CallbackUrl: str
|
|
@@ -6641,14 +6702,13 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
|
|
|
6641
6702
|
|
|
6642
6703
|
@property
|
|
6643
6704
|
def ReleasedApprovers(self):
|
|
6644
|
-
"""
|
|
6705
|
+
"""替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
|
|
6645
6706
|
如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
|
|
6646
6707
|
|
|
6647
|
-
|
|
6648
|
-
|
|
6649
|
-
|
|
6650
|
-
<
|
|
6651
|
-
</ul>
|
|
6708
|
+
注:
|
|
6709
|
+
1. 支持更换企业的签署人,不支持更换个人类型的签署人。
|
|
6710
|
+
2. 己方企业支持自动签署,他方企业不支持自动签署。
|
|
6711
|
+
3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。
|
|
6652
6712
|
:rtype: list of ReleasedApprover
|
|
6653
6713
|
"""
|
|
6654
6714
|
return self._ReleasedApprovers
|
|
@@ -11718,12 +11778,20 @@ class Component(AbstractModel):
|
|
|
11718
11778
|
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
11719
11779
|
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
11720
11780
|
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
11781
|
+
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
|
|
11782
|
+
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
|
|
11783
|
+
<li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
|
|
11721
11784
|
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
|
|
11722
11785
|
|
|
11786
|
+
|
|
11723
11787
|
* 个人方
|
|
11724
11788
|
<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
11725
11789
|
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
11726
|
-
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li
|
|
11790
|
+
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
11791
|
+
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
|
|
11792
|
+
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
|
|
11793
|
+
<li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
|
|
11794
|
+
</ul>
|
|
11727
11795
|
|
|
11728
11796
|
注:` 表单域的控件不能作为印章和签名控件`
|
|
11729
11797
|
:type ComponentType: str
|
|
@@ -11820,10 +11888,115 @@ class Component(AbstractModel):
|
|
|
11820
11888
|
<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>
|
|
11821
11889
|
<b>参数样例</b>:`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
|
|
11822
11890
|
|
|
11891
|
+
<font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
|
|
11892
|
+
<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>
|
|
11893
|
+
<b>参数样例</b>:`{"Opacity":0.7}`
|
|
11894
|
+
|
|
11823
11895
|
<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
|
|
11824
11896
|
<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
|
|
11825
11897
|
场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
|
|
11826
11898
|
<b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
|
|
11899
|
+
|
|
11900
|
+
|
|
11901
|
+
<font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:
|
|
11902
|
+
<ul>
|
|
11903
|
+
<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>
|
|
11904
|
+
<b>参数样例</b>:<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
|
|
11905
|
+
<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>
|
|
11906
|
+
ChildrenComponent结构体定义:
|
|
11907
|
+
<table border="1">
|
|
11908
|
+
<thead>
|
|
11909
|
+
<tr>
|
|
11910
|
+
<th>字段名称</th>
|
|
11911
|
+
<th>类型</th>
|
|
11912
|
+
<th>描述</th>
|
|
11913
|
+
</tr>
|
|
11914
|
+
</thead>
|
|
11915
|
+
<tbody>
|
|
11916
|
+
<tr>
|
|
11917
|
+
<td>ComponentType</td>
|
|
11918
|
+
<td>string</td>
|
|
11919
|
+
<td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>
|
|
11920
|
+
</tr>
|
|
11921
|
+
<tr>
|
|
11922
|
+
<td>ComponentName</td>
|
|
11923
|
+
<td>string</td>
|
|
11924
|
+
<td>子控件名称</td>
|
|
11925
|
+
</tr>
|
|
11926
|
+
<tr>
|
|
11927
|
+
<td>Placeholder</td>
|
|
11928
|
+
<td>string</td>
|
|
11929
|
+
<td>子控件提示语</td>
|
|
11930
|
+
</tr>
|
|
11931
|
+
<tr>
|
|
11932
|
+
<td>ComponentOffsetX</td>
|
|
11933
|
+
<td>float</td>
|
|
11934
|
+
<td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>
|
|
11935
|
+
</tr>
|
|
11936
|
+
<tr>
|
|
11937
|
+
<td>ComponentOffsetY</td>
|
|
11938
|
+
<td>float</td>
|
|
11939
|
+
<td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>
|
|
11940
|
+
</tr>
|
|
11941
|
+
<tr>
|
|
11942
|
+
<td>ComponentWidth</td>
|
|
11943
|
+
<td>float</td>
|
|
11944
|
+
<td>控件宽</td>
|
|
11945
|
+
</tr>
|
|
11946
|
+
<tr>
|
|
11947
|
+
<td>ComponentHeight</td>
|
|
11948
|
+
<td>float</td>
|
|
11949
|
+
<td>控件高</td>
|
|
11950
|
+
</tr>
|
|
11951
|
+
<tr>
|
|
11952
|
+
<td>ComponentExtra</td>
|
|
11953
|
+
<td>string</td>
|
|
11954
|
+
<td>控件的附属信息,根据ComponentType设置</td>
|
|
11955
|
+
</tr>
|
|
11956
|
+
</tbody>
|
|
11957
|
+
</table>
|
|
11958
|
+
<b>参数样例</b>:
|
|
11959
|
+
```json
|
|
11960
|
+
{
|
|
11961
|
+
"ChildrenComponents": [
|
|
11962
|
+
{
|
|
11963
|
+
"ComponentType": "SIGN_SIGNATURE",
|
|
11964
|
+
"ComponentName": "个人签名",
|
|
11965
|
+
"Placeholder": "请签名",
|
|
11966
|
+
"ComponentOffsetX": 10,
|
|
11967
|
+
"ComponentOffsetY": 30,
|
|
11968
|
+
"ComponentWidth": 119,
|
|
11969
|
+
"ComponentHeight": 43,
|
|
11970
|
+
"ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"
|
|
11971
|
+
},
|
|
11972
|
+
{
|
|
11973
|
+
"ComponentType": "SIGN_SELECTOR",
|
|
11974
|
+
"ComponentName": "是否同意此协议",
|
|
11975
|
+
"Placeholder": "",
|
|
11976
|
+
"ComponentOffsetX": 50,
|
|
11977
|
+
"ComponentOffsetY": 130,
|
|
11978
|
+
"ComponentWidth": 120,
|
|
11979
|
+
"ComponentHeight": 43,
|
|
11980
|
+
"ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"
|
|
11981
|
+
},
|
|
11982
|
+
{
|
|
11983
|
+
"ComponentType": "SIGN_MULTI_LINE_TEXT",
|
|
11984
|
+
"ComponentName": "批注附言",
|
|
11985
|
+
"Placeholder": "",
|
|
11986
|
+
"ComponentOffsetX": 150,
|
|
11987
|
+
"ComponentOffsetY": 300,
|
|
11988
|
+
"ComponentWidth": 200,
|
|
11989
|
+
"ComponentHeight": 86,
|
|
11990
|
+
"ComponentExtra": ""
|
|
11991
|
+
}
|
|
11992
|
+
]
|
|
11993
|
+
}
|
|
11994
|
+
```
|
|
11995
|
+
</ul>
|
|
11996
|
+
|
|
11997
|
+
|
|
11998
|
+
|
|
11999
|
+
|
|
11827
12000
|
:type ComponentExtra: str
|
|
11828
12001
|
:param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
11829
12002
|
<ul><li> <b>TEXT</b> : 文本内容</li>
|
|
@@ -11965,12 +12138,20 @@ class Component(AbstractModel):
|
|
|
11965
12138
|
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
11966
12139
|
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
11967
12140
|
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
12141
|
+
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
|
|
12142
|
+
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
|
|
12143
|
+
<li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
|
|
11968
12144
|
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
|
|
11969
12145
|
|
|
12146
|
+
|
|
11970
12147
|
* 个人方
|
|
11971
12148
|
<ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
11972
12149
|
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
11973
|
-
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li
|
|
12150
|
+
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
12151
|
+
<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
|
|
12152
|
+
<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
|
|
12153
|
+
<li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
|
|
12154
|
+
</ul>
|
|
11974
12155
|
|
|
11975
12156
|
注:` 表单域的控件不能作为印章和签名控件`
|
|
11976
12157
|
:rtype: str
|
|
@@ -12166,10 +12347,115 @@ class Component(AbstractModel):
|
|
|
12166
12347
|
<li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>
|
|
12167
12348
|
<b>参数样例</b>:`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
|
|
12168
12349
|
|
|
12350
|
+
<font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
|
|
12351
|
+
<ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>
|
|
12352
|
+
<b>参数样例</b>:`{"Opacity":0.7}`
|
|
12353
|
+
|
|
12169
12354
|
<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
|
|
12170
12355
|
<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
|
|
12171
12356
|
场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
|
|
12172
12357
|
<b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
|
|
12358
|
+
|
|
12359
|
+
|
|
12360
|
+
<font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:
|
|
12361
|
+
<ul>
|
|
12362
|
+
<li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>
|
|
12363
|
+
<b>参数样例</b>:<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
|
|
12364
|
+
<li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>
|
|
12365
|
+
ChildrenComponent结构体定义:
|
|
12366
|
+
<table border="1">
|
|
12367
|
+
<thead>
|
|
12368
|
+
<tr>
|
|
12369
|
+
<th>字段名称</th>
|
|
12370
|
+
<th>类型</th>
|
|
12371
|
+
<th>描述</th>
|
|
12372
|
+
</tr>
|
|
12373
|
+
</thead>
|
|
12374
|
+
<tbody>
|
|
12375
|
+
<tr>
|
|
12376
|
+
<td>ComponentType</td>
|
|
12377
|
+
<td>string</td>
|
|
12378
|
+
<td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>
|
|
12379
|
+
</tr>
|
|
12380
|
+
<tr>
|
|
12381
|
+
<td>ComponentName</td>
|
|
12382
|
+
<td>string</td>
|
|
12383
|
+
<td>子控件名称</td>
|
|
12384
|
+
</tr>
|
|
12385
|
+
<tr>
|
|
12386
|
+
<td>Placeholder</td>
|
|
12387
|
+
<td>string</td>
|
|
12388
|
+
<td>子控件提示语</td>
|
|
12389
|
+
</tr>
|
|
12390
|
+
<tr>
|
|
12391
|
+
<td>ComponentOffsetX</td>
|
|
12392
|
+
<td>float</td>
|
|
12393
|
+
<td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>
|
|
12394
|
+
</tr>
|
|
12395
|
+
<tr>
|
|
12396
|
+
<td>ComponentOffsetY</td>
|
|
12397
|
+
<td>float</td>
|
|
12398
|
+
<td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>
|
|
12399
|
+
</tr>
|
|
12400
|
+
<tr>
|
|
12401
|
+
<td>ComponentWidth</td>
|
|
12402
|
+
<td>float</td>
|
|
12403
|
+
<td>控件宽</td>
|
|
12404
|
+
</tr>
|
|
12405
|
+
<tr>
|
|
12406
|
+
<td>ComponentHeight</td>
|
|
12407
|
+
<td>float</td>
|
|
12408
|
+
<td>控件高</td>
|
|
12409
|
+
</tr>
|
|
12410
|
+
<tr>
|
|
12411
|
+
<td>ComponentExtra</td>
|
|
12412
|
+
<td>string</td>
|
|
12413
|
+
<td>控件的附属信息,根据ComponentType设置</td>
|
|
12414
|
+
</tr>
|
|
12415
|
+
</tbody>
|
|
12416
|
+
</table>
|
|
12417
|
+
<b>参数样例</b>:
|
|
12418
|
+
```json
|
|
12419
|
+
{
|
|
12420
|
+
"ChildrenComponents": [
|
|
12421
|
+
{
|
|
12422
|
+
"ComponentType": "SIGN_SIGNATURE",
|
|
12423
|
+
"ComponentName": "个人签名",
|
|
12424
|
+
"Placeholder": "请签名",
|
|
12425
|
+
"ComponentOffsetX": 10,
|
|
12426
|
+
"ComponentOffsetY": 30,
|
|
12427
|
+
"ComponentWidth": 119,
|
|
12428
|
+
"ComponentHeight": 43,
|
|
12429
|
+
"ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"
|
|
12430
|
+
},
|
|
12431
|
+
{
|
|
12432
|
+
"ComponentType": "SIGN_SELECTOR",
|
|
12433
|
+
"ComponentName": "是否同意此协议",
|
|
12434
|
+
"Placeholder": "",
|
|
12435
|
+
"ComponentOffsetX": 50,
|
|
12436
|
+
"ComponentOffsetY": 130,
|
|
12437
|
+
"ComponentWidth": 120,
|
|
12438
|
+
"ComponentHeight": 43,
|
|
12439
|
+
"ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"
|
|
12440
|
+
},
|
|
12441
|
+
{
|
|
12442
|
+
"ComponentType": "SIGN_MULTI_LINE_TEXT",
|
|
12443
|
+
"ComponentName": "批注附言",
|
|
12444
|
+
"Placeholder": "",
|
|
12445
|
+
"ComponentOffsetX": 150,
|
|
12446
|
+
"ComponentOffsetY": 300,
|
|
12447
|
+
"ComponentWidth": 200,
|
|
12448
|
+
"ComponentHeight": 86,
|
|
12449
|
+
"ComponentExtra": ""
|
|
12450
|
+
}
|
|
12451
|
+
]
|
|
12452
|
+
}
|
|
12453
|
+
```
|
|
12454
|
+
</ul>
|
|
12455
|
+
|
|
12456
|
+
|
|
12457
|
+
|
|
12458
|
+
|
|
12173
12459
|
:rtype: str
|
|
12174
12460
|
"""
|
|
12175
12461
|
return self._ComponentExtra
|
|
@@ -12514,15 +12800,28 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
|
|
|
12514
12800
|
:param _Agent: 应用相关信息。 此接口Agent.AppId 必填。
|
|
12515
12801
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
12516
12802
|
:param _OperateTypes: 初始化操作类型
|
|
12517
|
-
<ul
|
|
12518
|
-
<li>
|
|
12803
|
+
<ul>
|
|
12804
|
+
<li>CREATE_SEAL : 创建印章</li>
|
|
12805
|
+
<li>OPEN_AUTO_SIGN :开通企业自动签署</li>
|
|
12806
|
+
<li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签</li>
|
|
12807
|
+
</ul>
|
|
12519
12808
|
:type OperateTypes: list of str
|
|
12520
12809
|
:param _ProxyOrganizationOpenIds: 批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个
|
|
12521
12810
|
:type ProxyOrganizationOpenIds: list of str
|
|
12811
|
+
:param _IsAuthorizePlatformApplication: 当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。
|
|
12812
|
+

|
|
12813
|
+
:type IsAuthorizePlatformApplication: bool
|
|
12814
|
+
:param _AuthorizedProxyOrganizationOpenId: 被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。
|
|
12815
|
+
|
|
12816
|
+
|
|
12817
|
+
|
|
12818
|
+
:type AuthorizedProxyOrganizationOpenId: str
|
|
12522
12819
|
"""
|
|
12523
12820
|
self._Agent = None
|
|
12524
12821
|
self._OperateTypes = None
|
|
12525
12822
|
self._ProxyOrganizationOpenIds = None
|
|
12823
|
+
self._IsAuthorizePlatformApplication = None
|
|
12824
|
+
self._AuthorizedProxyOrganizationOpenId = None
|
|
12526
12825
|
|
|
12527
12826
|
@property
|
|
12528
12827
|
def Agent(self):
|
|
@@ -12538,8 +12837,11 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
|
|
|
12538
12837
|
@property
|
|
12539
12838
|
def OperateTypes(self):
|
|
12540
12839
|
"""初始化操作类型
|
|
12541
|
-
<ul
|
|
12542
|
-
<li>
|
|
12840
|
+
<ul>
|
|
12841
|
+
<li>CREATE_SEAL : 创建印章</li>
|
|
12842
|
+
<li>OPEN_AUTO_SIGN :开通企业自动签署</li>
|
|
12843
|
+
<li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签</li>
|
|
12844
|
+
</ul>
|
|
12543
12845
|
:rtype: list of str
|
|
12544
12846
|
"""
|
|
12545
12847
|
return self._OperateTypes
|
|
@@ -12559,6 +12861,32 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
|
|
|
12559
12861
|
def ProxyOrganizationOpenIds(self, ProxyOrganizationOpenIds):
|
|
12560
12862
|
self._ProxyOrganizationOpenIds = ProxyOrganizationOpenIds
|
|
12561
12863
|
|
|
12864
|
+
@property
|
|
12865
|
+
def IsAuthorizePlatformApplication(self):
|
|
12866
|
+
"""当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。
|
|
12867
|
+

|
|
12868
|
+
:rtype: bool
|
|
12869
|
+
"""
|
|
12870
|
+
return self._IsAuthorizePlatformApplication
|
|
12871
|
+
|
|
12872
|
+
@IsAuthorizePlatformApplication.setter
|
|
12873
|
+
def IsAuthorizePlatformApplication(self, IsAuthorizePlatformApplication):
|
|
12874
|
+
self._IsAuthorizePlatformApplication = IsAuthorizePlatformApplication
|
|
12875
|
+
|
|
12876
|
+
@property
|
|
12877
|
+
def AuthorizedProxyOrganizationOpenId(self):
|
|
12878
|
+
"""被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。
|
|
12879
|
+
|
|
12880
|
+
|
|
12881
|
+
|
|
12882
|
+
:rtype: str
|
|
12883
|
+
"""
|
|
12884
|
+
return self._AuthorizedProxyOrganizationOpenId
|
|
12885
|
+
|
|
12886
|
+
@AuthorizedProxyOrganizationOpenId.setter
|
|
12887
|
+
def AuthorizedProxyOrganizationOpenId(self, AuthorizedProxyOrganizationOpenId):
|
|
12888
|
+
self._AuthorizedProxyOrganizationOpenId = AuthorizedProxyOrganizationOpenId
|
|
12889
|
+
|
|
12562
12890
|
|
|
12563
12891
|
def _deserialize(self, params):
|
|
12564
12892
|
if params.get("Agent") is not None:
|
|
@@ -12566,6 +12894,8 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
|
|
|
12566
12894
|
self._Agent._deserialize(params.get("Agent"))
|
|
12567
12895
|
self._OperateTypes = params.get("OperateTypes")
|
|
12568
12896
|
self._ProxyOrganizationOpenIds = params.get("ProxyOrganizationOpenIds")
|
|
12897
|
+
self._IsAuthorizePlatformApplication = params.get("IsAuthorizePlatformApplication")
|
|
12898
|
+
self._AuthorizedProxyOrganizationOpenId = params.get("AuthorizedProxyOrganizationOpenId")
|
|
12569
12899
|
memeber_set = set(params.keys())
|
|
12570
12900
|
for name, value in vars(self).items():
|
|
12571
12901
|
property_name = name[1:]
|
|
@@ -14998,26 +15328,39 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
|
|
|
14998
15328
|
</ul>
|
|
14999
15329
|
第三方平台子客企业和员工必须已经经过实名认证
|
|
15000
15330
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
15001
|
-
:param _AuthorizedOrganizationId: 被授企业id
|
|
15331
|
+
:param _AuthorizedOrganizationId: 被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。
|
|
15332
|
+
|
|
15002
15333
|
注:`被授权企业必须和当前企业在同一应用号下`
|
|
15003
15334
|
:type AuthorizedOrganizationId: str
|
|
15004
|
-
:param _AuthorizedOrganizationName:
|
|
15005
|
-
|
|
15335
|
+
:param _AuthorizedOrganizationName: 被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
|
|
15336
|
+
|
|
15337
|
+
注:
|
|
15338
|
+
1. 如果名称中包含英文括号(),请使用中文括号()代替。
|
|
15339
|
+
2. 被授权企业必须和当前企业在同一应用号下
|
|
15006
15340
|
:type AuthorizedOrganizationName: str
|
|
15007
|
-
:param _PlatformAppAuthorization:
|
|
15008
|
-
- true: 是(无需设置AuthorizedOrganizationId和AuthorizedOrganizationName)
|
|
15009
|
-
- false: 否(默认)
|
|
15010
|
-
注:该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”,请联系运营经理开通
|
|
15341
|
+
:param _PlatformAppAuthorization: 是否给平台应用授权
|
|
15011
15342
|
|
|
15343
|
+
<ul>
|
|
15344
|
+
<li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>
|
|
15345
|
+
<li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>
|
|
15346
|
+
</ul>
|
|
15347
|
+
|
|
15348
|
+
注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。
|
|
15012
15349
|
:type PlatformAppAuthorization: bool
|
|
15013
|
-
:param _SealTypes:
|
|
15014
|
-
|
|
15015
|
-
|
|
15016
|
-
|
|
15017
|
-
|
|
15018
|
-
|
|
15350
|
+
:param _SealTypes: 在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:
|
|
15351
|
+
|
|
15352
|
+
<ul>
|
|
15353
|
+
<li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>
|
|
15354
|
+
<li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>
|
|
15355
|
+
<li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>
|
|
15356
|
+
<li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>
|
|
15357
|
+
</ul>
|
|
15019
15358
|
:type SealTypes: list of str
|
|
15020
|
-
:param _AuthToMe:
|
|
15359
|
+
:param _AuthToMe: 在处理授权关系时,授权的方向
|
|
15360
|
+
<ul>
|
|
15361
|
+
<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
|
|
15362
|
+
<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
|
|
15363
|
+
</ul>
|
|
15021
15364
|
:type AuthToMe: bool
|
|
15022
15365
|
"""
|
|
15023
15366
|
self._Agent = None
|
|
@@ -15048,7 +15391,8 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
|
|
|
15048
15391
|
|
|
15049
15392
|
@property
|
|
15050
15393
|
def AuthorizedOrganizationId(self):
|
|
15051
|
-
"""被授企业id
|
|
15394
|
+
"""被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。
|
|
15395
|
+
|
|
15052
15396
|
注:`被授权企业必须和当前企业在同一应用号下`
|
|
15053
15397
|
:rtype: str
|
|
15054
15398
|
"""
|
|
@@ -15060,8 +15404,11 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
|
|
|
15060
15404
|
|
|
15061
15405
|
@property
|
|
15062
15406
|
def AuthorizedOrganizationName(self):
|
|
15063
|
-
"""
|
|
15064
|
-
|
|
15407
|
+
"""被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
|
|
15408
|
+
|
|
15409
|
+
注:
|
|
15410
|
+
1. 如果名称中包含英文括号(),请使用中文括号()代替。
|
|
15411
|
+
2. 被授权企业必须和当前企业在同一应用号下
|
|
15065
15412
|
:rtype: str
|
|
15066
15413
|
"""
|
|
15067
15414
|
return self._AuthorizedOrganizationName
|
|
@@ -15072,11 +15419,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
|
|
|
15072
15419
|
|
|
15073
15420
|
@property
|
|
15074
15421
|
def PlatformAppAuthorization(self):
|
|
15075
|
-
"""
|
|
15076
|
-
- true: 是(无需设置AuthorizedOrganizationId和AuthorizedOrganizationName)
|
|
15077
|
-
- false: 否(默认)
|
|
15078
|
-
注:该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”,请联系运营经理开通
|
|
15422
|
+
"""是否给平台应用授权
|
|
15079
15423
|
|
|
15424
|
+
<ul>
|
|
15425
|
+
<li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>
|
|
15426
|
+
<li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>
|
|
15427
|
+
</ul>
|
|
15428
|
+
|
|
15429
|
+
注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。
|
|
15080
15430
|
:rtype: bool
|
|
15081
15431
|
"""
|
|
15082
15432
|
return self._PlatformAppAuthorization
|
|
@@ -15087,12 +15437,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
|
|
|
15087
15437
|
|
|
15088
15438
|
@property
|
|
15089
15439
|
def SealTypes(self):
|
|
15090
|
-
"""
|
|
15091
|
-
|
|
15092
|
-
|
|
15093
|
-
|
|
15094
|
-
|
|
15095
|
-
|
|
15440
|
+
"""在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:
|
|
15441
|
+
|
|
15442
|
+
<ul>
|
|
15443
|
+
<li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>
|
|
15444
|
+
<li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>
|
|
15445
|
+
<li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>
|
|
15446
|
+
<li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>
|
|
15447
|
+
</ul>
|
|
15096
15448
|
:rtype: list of str
|
|
15097
15449
|
"""
|
|
15098
15450
|
return self._SealTypes
|
|
@@ -15103,7 +15455,11 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
|
|
|
15103
15455
|
|
|
15104
15456
|
@property
|
|
15105
15457
|
def AuthToMe(self):
|
|
15106
|
-
"""
|
|
15458
|
+
"""在处理授权关系时,授权的方向
|
|
15459
|
+
<ul>
|
|
15460
|
+
<li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
|
|
15461
|
+
<li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
|
|
15462
|
+
</ul>
|
|
15107
15463
|
:rtype: bool
|
|
15108
15464
|
"""
|
|
15109
15465
|
return self._AuthToMe
|
|
@@ -15757,7 +16113,7 @@ class CreateSignUrlsRequest(AbstractModel):
|
|
|
15757
16113
|
:type FlowGroupId: str
|
|
15758
16114
|
:param _Endpoint: 签署链接类型,可以设置的参数如下
|
|
15759
16115
|
<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
|
|
15760
|
-
<li> **CHANNEL** :带有H5
|
|
16116
|
+
<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
|
|
15761
16117
|
<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
|
|
15762
16118
|
<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
|
|
15763
16119
|
|
|
@@ -15897,7 +16253,7 @@ class CreateSignUrlsRequest(AbstractModel):
|
|
|
15897
16253
|
def Endpoint(self):
|
|
15898
16254
|
"""签署链接类型,可以设置的参数如下
|
|
15899
16255
|
<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
|
|
15900
|
-
<li> **CHANNEL** :带有H5
|
|
16256
|
+
<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
|
|
15901
16257
|
<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
|
|
15902
16258
|
<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
|
|
15903
16259
|
|
|
@@ -18002,7 +18358,7 @@ class DescribeTemplatesRequest(AbstractModel):
|
|
|
18002
18358
|
|
|
18003
18359
|
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
|
18004
18360
|
|
|
18005
|
-
注:
|
|
18361
|
+
注: `此功能需要开通功能白名单【第三方应用集成企业获取模版PDF下载链接】,使用前请联系对接的客户经理沟通。`
|
|
18006
18362
|
:type WithPdfUrl: bool
|
|
18007
18363
|
:param _Operator: 操作者的信息
|
|
18008
18364
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
@@ -18177,7 +18533,7 @@ class DescribeTemplatesRequest(AbstractModel):
|
|
|
18177
18533
|
|
|
18178
18534
|
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
|
18179
18535
|
|
|
18180
|
-
注:
|
|
18536
|
+
注: `此功能需要开通功能白名单【第三方应用集成企业获取模版PDF下载链接】,使用前请联系对接的客户经理沟通。`
|
|
18181
18537
|
:rtype: bool
|
|
18182
18538
|
"""
|
|
18183
18539
|
return self._WithPdfUrl
|
|
@@ -19689,14 +20045,16 @@ class FlowApproverInfo(AbstractModel):
|
|
|
19689
20045
|
:param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人、是否为动态补充签署人等。
|
|
19690
20046
|
详细操作可以参考开发者中心的ApproverOption结构体。
|
|
19691
20047
|
:type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
|
|
19692
|
-
:param _ApproverNeedSignReview:
|
|
20048
|
+
:param _ApproverNeedSignReview: 此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:
|
|
19693
20049
|
<ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
|
19694
|
-
<li>**true
|
|
20050
|
+
<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>
|
|
19695
20051
|
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
19696
20052
|
<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
19697
20053
|
<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
19698
20054
|
|
|
19699
|
-
|
|
20055
|
+
注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
20056
|
+
|
|
20057
|
+

|
|
19700
20058
|
:type ApproverNeedSignReview: bool
|
|
19701
20059
|
:param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
|
|
19702
20060
|
<ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
|
|
@@ -19767,6 +20125,9 @@ class FlowApproverInfo(AbstractModel):
|
|
|
19767
20125
|
2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
|
|
19768
20126
|
3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
|
|
19769
20127
|
:type Intention: :class:`tencentcloud.essbasic.v20210526.models.Intention`
|
|
20128
|
+
:param _SignEndpoints: 进入签署流程的限制,目前支持以下选项:
|
|
20129
|
+
<ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
|
|
20130
|
+
:type SignEndpoints: list of str
|
|
19770
20131
|
"""
|
|
19771
20132
|
self._Name = None
|
|
19772
20133
|
self._IdCardType = None
|
|
@@ -19795,6 +20156,7 @@ class FlowApproverInfo(AbstractModel):
|
|
|
19795
20156
|
self._SignTypeSelector = None
|
|
19796
20157
|
self._Components = None
|
|
19797
20158
|
self._Intention = None
|
|
20159
|
+
self._SignEndpoints = None
|
|
19798
20160
|
|
|
19799
20161
|
@property
|
|
19800
20162
|
def Name(self):
|
|
@@ -20043,14 +20405,16 @@ class FlowApproverInfo(AbstractModel):
|
|
|
20043
20405
|
|
|
20044
20406
|
@property
|
|
20045
20407
|
def ApproverNeedSignReview(self):
|
|
20046
|
-
"""
|
|
20408
|
+
"""此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:
|
|
20047
20409
|
<ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
|
20048
|
-
<li>**true
|
|
20410
|
+
<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>
|
|
20049
20411
|
企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
20050
20412
|
<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
20051
20413
|
<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
20052
20414
|
|
|
20053
|
-
|
|
20415
|
+
注:`此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
20416
|
+
|
|
20417
|
+

|
|
20054
20418
|
:rtype: bool
|
|
20055
20419
|
"""
|
|
20056
20420
|
return self._ApproverNeedSignReview
|
|
@@ -20209,6 +20573,18 @@ class FlowApproverInfo(AbstractModel):
|
|
|
20209
20573
|
def Intention(self, Intention):
|
|
20210
20574
|
self._Intention = Intention
|
|
20211
20575
|
|
|
20576
|
+
@property
|
|
20577
|
+
def SignEndpoints(self):
|
|
20578
|
+
"""进入签署流程的限制,目前支持以下选项:
|
|
20579
|
+
<ul><li> <b>空值(默认)</b> :无限制,可在任何场景进入签署流程。</li><li> <b>link</b> :选择此选项后,将无法通过控制台或电子签小程序列表进入填写或签署操作,仅可预览合同。填写或签署流程只能通过短信或发起方提供的专用链接进行。</li></ul>
|
|
20580
|
+
:rtype: list of str
|
|
20581
|
+
"""
|
|
20582
|
+
return self._SignEndpoints
|
|
20583
|
+
|
|
20584
|
+
@SignEndpoints.setter
|
|
20585
|
+
def SignEndpoints(self, SignEndpoints):
|
|
20586
|
+
self._SignEndpoints = SignEndpoints
|
|
20587
|
+
|
|
20212
20588
|
|
|
20213
20589
|
def _deserialize(self, params):
|
|
20214
20590
|
self._Name = params.get("Name")
|
|
@@ -20257,6 +20633,7 @@ class FlowApproverInfo(AbstractModel):
|
|
|
20257
20633
|
if params.get("Intention") is not None:
|
|
20258
20634
|
self._Intention = Intention()
|
|
20259
20635
|
self._Intention._deserialize(params.get("Intention"))
|
|
20636
|
+
self._SignEndpoints = params.get("SignEndpoints")
|
|
20260
20637
|
memeber_set = set(params.keys())
|
|
20261
20638
|
for name, value in vars(self).items():
|
|
20262
20639
|
property_name = name[1:]
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
Metadata-Version: 1.
|
|
1
|
+
Metadata-Version: 1.2
|
|
2
2
|
Name: tencentcloud-sdk-python-essbasic
|
|
3
|
-
Version: 3.0.
|
|
3
|
+
Version: 3.0.1276
|
|
4
4
|
Summary: Tencent Cloud Essbasic SDK for Python
|
|
5
5
|
Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
|
|
6
6
|
Author: Tencent Cloud
|
|
7
|
-
|
|
7
|
+
Maintainer-email: tencentcloudapi@tencent.com
|
|
8
8
|
License: Apache License 2.0
|
|
9
9
|
Description: ============================
|
|
10
10
|
Tencent Cloud SDK for Python
|
tencentcloud-sdk-python-essbasic-3.0.1276/tencentcloud_sdk_python_essbasic.egg-info/requires.txt
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
tencentcloud-sdk-python-common==3.0.1276
|
tencentcloud-sdk-python-essbasic-3.0.1264/tencentcloud_sdk_python_essbasic.egg-info/requires.txt
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
tencentcloud-sdk-python-common==3.0.1264
|
{tencentcloud-sdk-python-essbasic-3.0.1264 → tencentcloud-sdk-python-essbasic-3.0.1276}/README.rst
RENAMED
|
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
|
|
File without changes
|