tencentcloud-sdk-python-ess 3.0.1056__tar.gz → 3.0.1062__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.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/PKG-INFO +1 -1
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/setup.py +1 -1
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud/__init__.py +1 -1
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud/ess/v20201111/ess_client.py +152 -16
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud/ess/v20201111/models.py +556 -312
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +1 -1
- tencentcloud-sdk-python-ess-3.0.1062/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
- tencentcloud-sdk-python-ess-3.0.1056/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/README.rst +0 -0
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/setup.cfg +0 -0
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud/ess/__init__.py +0 -0
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud/ess/v20201111/__init__.py +0 -0
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
- {tencentcloud-sdk-python-ess-3.0.1056 → tencentcloud-sdk-python-ess-3.0.1062}/tencentcloud_sdk_python_ess.egg-info/top_level.txt +0 -0
|
@@ -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.0.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common==3.0.1062"],
|
|
12
12
|
version=tencentcloud.__version__,
|
|
13
13
|
description='Tencent Cloud Ess SDK for Python',
|
|
14
14
|
long_description=open('README.rst').read(),
|
|
@@ -157,7 +157,7 @@ class EssClient(AbstractClient):
|
|
|
157
157
|
"""该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。
|
|
158
158
|
**注意：**
|
|
159
159
|
1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
|
|
160
|
-
2. 该接口可生成批量签署链接的C
|
|
160
|
+
2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**，**不支持填写控件** 。
|
|
161
161
|
3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。
|
|
162
162
|
4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
|
|
163
163
|
5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
|
|
@@ -249,7 +249,7 @@ class EssClient(AbstractClient):
|
|
|
249
249
|
|
|
250
250
|
注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
|
|
251
251
|
|
|
252
|
-
|
|
252
|
+
|
|
253
253
|
|
|
254
254
|
:param request: Request instance for CreateDocument.
|
|
255
255
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateDocumentRequest`
|
|
@@ -330,10 +330,39 @@ class EssClient(AbstractClient):
|
|
|
330
330
|
def CreateFlow(self, request):
|
|
331
331
|
"""通过模板创建签署流程<br/>
|
|
332
332
|
适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
|
|
333
|
+
<table>
|
|
334
|
+
<thead>
|
|
335
|
+
<tr>
|
|
336
|
+
<th>签署人类别</th>
|
|
337
|
+
<th>需要提前准备的信息</th>
|
|
338
|
+
</tr>
|
|
339
|
+
</thead>
|
|
340
|
+
<tbody>
|
|
341
|
+
<tr>
|
|
342
|
+
<td>自己企业的员工签署（未认证加入或已认证加入）</td>
|
|
343
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
344
|
+
</tr>
|
|
345
|
+
<tr>
|
|
346
|
+
<td>自己企业的员工签署（已认证加入）</td>
|
|
347
|
+
<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
|
|
348
|
+
</tr>
|
|
349
|
+
<tr>
|
|
350
|
+
<td>其他企业的员工签署</td>
|
|
351
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
352
|
+
</tr>
|
|
353
|
+
<tr>
|
|
354
|
+
<td>个人（自然人）签署</td>
|
|
355
|
+
<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
|
|
356
|
+
</tr>
|
|
357
|
+
</tbody>
|
|
358
|
+
</table>
|
|
359
|
+
|
|
333
360
|
|
|
334
361
|
注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
|
|
335
362
|
|
|
336
|
-
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
注：**静默（自动）签署不支持合同签署方存在填写**功能
|
|
337
366
|
|
|
338
367
|
:param request: Request instance for CreateFlow.
|
|
339
368
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowRequest`
|
|
@@ -386,9 +415,46 @@ class EssClient(AbstractClient):
|
|
|
386
415
|
|
|
387
416
|
def CreateFlowByFiles(self, request):
|
|
388
417
|
"""此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
418
|
+
适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
|
|
419
|
+
|
|
420
|
+
<table>
|
|
421
|
+
<thead>
|
|
422
|
+
<tr>
|
|
423
|
+
<th>签署人类别</th>
|
|
424
|
+
<th>需要提前准备的信息</th>
|
|
425
|
+
</tr>
|
|
426
|
+
</thead>
|
|
427
|
+
<tbody>
|
|
428
|
+
<tr>
|
|
429
|
+
<td>自己企业的员工签署（未认证加入或已认证加入）</td>
|
|
430
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
431
|
+
</tr>
|
|
432
|
+
<tr>
|
|
433
|
+
<td>自己企业的员工签署（已认证加入）</td>
|
|
434
|
+
<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
|
|
435
|
+
</tr>
|
|
436
|
+
<tr>
|
|
437
|
+
<td>其他企业的员工签署</td>
|
|
438
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
439
|
+
</tr>
|
|
440
|
+
<tr>
|
|
441
|
+
<td>个人（自然人）签署</td>
|
|
442
|
+
<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
|
|
443
|
+
</tr>
|
|
444
|
+
</tbody>
|
|
445
|
+
</table>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
注：
|
|
455
|
+
- 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明
|
|
456
|
+
- 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
|
|
457
|
+
- **静默（自动）签署不支持合同签署方存在填写**功能
|
|
392
458
|
|
|
393
459
|
:param request: Request instance for CreateFlowByFiles.
|
|
394
460
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowByFilesRequest`
|
|
@@ -448,6 +514,8 @@ class EssClient(AbstractClient):
|
|
|
448
514
|
|
|
449
515
|
注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
|
|
450
516
|
|
|
517
|
+
注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
518
|
+
|
|
451
519
|
:param request: Request instance for CreateFlowGroupByFiles.
|
|
452
520
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupByFilesRequest`
|
|
453
521
|
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupByFilesResponse`
|
|
@@ -473,6 +541,8 @@ class EssClient(AbstractClient):
|
|
|
473
541
|
|
|
474
542
|
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
|
|
475
543
|
|
|
544
|
+
注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
545
|
+
|
|
476
546
|
:param request: Request instance for CreateFlowGroupByTemplates.
|
|
477
547
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupByTemplatesRequest`
|
|
478
548
|
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupByTemplatesResponse`
|
|
@@ -493,14 +563,47 @@ class EssClient(AbstractClient):
|
|
|
493
563
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
494
564
|
|
|
495
565
|
|
|
566
|
+
def CreateFlowGroupSignReview(self, request):
|
|
567
|
+
"""提交合同组签署流程审批结果的适用场景包括：
|
|
568
|
+
|
|
569
|
+
1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByTemplates)创建合同组签署流程时，若指定了以下参数 为true，则可以调用此接口提交企业内部签署审批结果。即使是自动签署也需要进行审核通过才会进行签署。
|
|
570
|
+
- [FlowGroupInfo.NeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#flowgroupinfo)
|
|
571
|
+
- [ApproverInfo.ApproverNeedSignReview](https://qian.tencent.com/developers/companyApis/dataTypes/#approverinfo)
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
2. 同一合同组，同一签署人可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
|
|
575
|
+
|
|
576
|
+
:param request: Request instance for CreateFlowGroupSignReview.
|
|
577
|
+
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupSignReviewRequest`
|
|
578
|
+
:rtype: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupSignReviewResponse`
|
|
579
|
+
|
|
580
|
+
"""
|
|
581
|
+
try:
|
|
582
|
+
params = request._serialize()
|
|
583
|
+
headers = request.headers
|
|
584
|
+
body = self.call("CreateFlowGroupSignReview", params, headers=headers)
|
|
585
|
+
response = json.loads(body)
|
|
586
|
+
model = models.CreateFlowGroupSignReviewResponse()
|
|
587
|
+
model._deserialize(response["Response"])
|
|
588
|
+
return model
|
|
589
|
+
except Exception as e:
|
|
590
|
+
if isinstance(e, TencentCloudSDKException):
|
|
591
|
+
raise
|
|
592
|
+
else:
|
|
593
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
594
|
+
|
|
595
|
+
|
|
496
596
|
def CreateFlowReminds(self, request):
|
|
497
597
|
"""指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
|
|
498
598
|
|
|
499
|
-
1.
|
|
500
|
-
2.
|
|
501
|
-
3.
|
|
599
|
+
1. 发起合同时，**签署人的NotifyType需设置为sms**
|
|
600
|
+
2. 合同中当前状态为 **待签署** 的签署人是催办的对象
|
|
601
|
+
3. **每个合同只能催办一次**
|
|
602
|
+
|
|
603
|
+
**催办的效果**: 对方会收到如下的短信通知
|
|
604
|
+
|
|
502
605
|
|
|
503
|
-
|
|
606
|
+
注：`合同催办是白名单功能，请联系客户经理申请开白后使用`
|
|
504
607
|
|
|
505
608
|
:param request: Request instance for CreateFlowReminds.
|
|
506
609
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowRemindsRequest`
|
|
@@ -523,9 +626,36 @@ class EssClient(AbstractClient):
|
|
|
523
626
|
|
|
524
627
|
|
|
525
628
|
def CreateFlowSignReview(self, request):
|
|
526
|
-
"""
|
|
527
|
-
|
|
528
|
-
|
|
629
|
+
"""提交企业流程审批结果
|
|
630
|
+
**当前存在两种审核操作：**
|
|
631
|
+
<ul>
|
|
632
|
+
<li>签署审核
|
|
633
|
+
<ul>
|
|
634
|
+
<li>在通过接口<ul>
|
|
635
|
+
<li>CreateFlowByFiles</li>
|
|
636
|
+
<li>CreateFlow</li>
|
|
637
|
+
<li>CreateFlowGroupByTemplates</li>
|
|
638
|
+
<li>CreateFlowGroupByFiles</li>
|
|
639
|
+
<li>CreatePrepareFlow</li>
|
|
640
|
+
</ul>
|
|
641
|
+
发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果</li>
|
|
642
|
+
<li>在通过接口
|
|
643
|
+
<ul>
|
|
644
|
+
<li>CreateFlowByFiles</li>
|
|
645
|
+
<li>CreateFlow</li>
|
|
646
|
+
<li>CreateFlowGroupByTemplates</li>
|
|
647
|
+
<li>CreateFlowGroupByFiles</li>
|
|
648
|
+
</ul>
|
|
649
|
+
发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果</li>
|
|
650
|
+
</ul>
|
|
651
|
+
</li>
|
|
652
|
+
<li>发起审核
|
|
653
|
+
<ul>
|
|
654
|
+
<li>通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效
|
|
655
|
+
</li>
|
|
656
|
+
</ul>
|
|
657
|
+
</li>
|
|
658
|
+
</ul>
|
|
529
659
|
|
|
530
660
|
:param request: Request instance for CreateFlowSignReview.
|
|
531
661
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignReviewRequest`
|
|
@@ -922,7 +1052,9 @@ class EssClient(AbstractClient):
|
|
|
922
1052
|
|
|
923
1053
|
注：
|
|
924
1054
|
`1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署`
|
|
1055
|
+
|
|
925
1056
|
`2. 签署链接的有效期为90天，超过有效期链接不可用`
|
|
1057
|
+
|
|
926
1058
|
`3. 如果需跳转详情页（即PathType值为1）进行填写或签署合同，需指定签署方信息：姓名、手机号码、企业名称等，才能生成正确的跳转链接`
|
|
927
1059
|
|
|
928
1060
|
其中小程序的原始Id如下，或者查看小程序信息自助获取。
|
|
@@ -1792,7 +1924,11 @@ class EssClient(AbstractClient):
|
|
|
1792
1924
|
"""此接口用于启动流程。它是模板发起合同的最后一步。
|
|
1793
1925
|
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
|
|
1794
1926
|
|
|
1795
|
-
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
注：
|
|
1930
|
+
- **合同发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
|
|
1931
|
+
- **静默（自动）签署不支持合同签署方存在填写**功能
|
|
1796
1932
|
|
|
1797
1933
|
:param request: Request instance for StartFlow.
|
|
1798
1934
|
:type request: :class:`tencentcloud.ess.v20201111.models.StartFlowRequest`
|
|
@@ -1871,8 +2007,8 @@ class EssClient(AbstractClient):
|
|
|
1871
2007
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1872
2008
|
|
|
1873
2009
|
注:
|
|
1874
|
-
1.
|
|
1875
|
-
2.
|
|
2010
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
2011
|
+
2. 调用此接口时需要设置单独的Domain请求域名，<font color="red">联调开发环境为: file.test.ess.tencent.cn，正式环境需要设置为:file.ess.tencent.cn</font>，代码示例
|
|
1876
2012
|
```
|
|
1877
2013
|
HttpProfile httpProfile = new HttpProfile();
|
|
1878
2014
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|