tencentcloud-sdk-python-essbasic 3.1.51__tar.gz → 3.1.58__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.
Files changed (22) hide show
  1. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/setup.py +1 -1
  3. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20210526/models.py +100 -128
  5. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +2 -2
  6. tencentcloud_sdk_python_essbasic-3.1.58/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  7. tencentcloud_sdk_python_essbasic-3.1.51/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  8. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/README.rst +0 -0
  9. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/setup.cfg +0 -0
  10. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/__init__.py +0 -0
  11. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  12. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  13. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  14. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20201222/essbasic_client_async.py +0 -0
  15. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20210526/essbasic_client.py +0 -0
  19. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud/essbasic/v20210526/essbasic_client_async.py +0 -0
  20. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  21. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  22. {tencentcloud_sdk_python_essbasic-3.1.51 → tencentcloud_sdk_python_essbasic-3.1.58}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.1.51
3
+ Version: 3.1.58
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
@@ -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.51
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.58
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-essbasic',
11
- install_requires=["tencentcloud-sdk-python-common>=3.1.51,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.58,<4.0.0"],
12
12
 
13
13
  version=tencentcloud.__version__,
14
14
  description='Tencent Cloud Essbasic SDK for Python',
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.51'
17
+ __version__ = '3.1.58'
@@ -4530,6 +4530,8 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4530
4530
  :type OpenDynamicFlow: bool
4531
4531
  :param _OpenDynamicSignFlow: <p>是否开启动态合同(动态签署人2.0)<ul><li> <strong>false</strong> :(默认) 不开启动态合同(动态签署人2.0)</li><li> <strong>true</strong> :开启动态合同(动态签署人2.0),发起时不设置签署方,发起后可继续追加合同签署人</li></ul></p>
4532
4532
  :type OpenDynamicSignFlow: bool
4533
+ :param _FlowOperateLimit: <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
4534
+ :type FlowOperateLimit: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
4533
4535
  """
4534
4536
  self._Agent = None
4535
4537
  self._FlowName = None
@@ -4555,6 +4557,7 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4555
4557
  self._PreviewType = None
4556
4558
  self._OpenDynamicFlow = None
4557
4559
  self._OpenDynamicSignFlow = None
4560
+ self._FlowOperateLimit = None
4558
4561
 
4559
4562
  @property
4560
4563
  def Agent(self):
@@ -4832,6 +4835,17 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4832
4835
  def OpenDynamicSignFlow(self, OpenDynamicSignFlow):
4833
4836
  self._OpenDynamicSignFlow = OpenDynamicSignFlow
4834
4837
 
4838
+ @property
4839
+ def FlowOperateLimit(self):
4840
+ r"""<p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
4841
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
4842
+ """
4843
+ return self._FlowOperateLimit
4844
+
4845
+ @FlowOperateLimit.setter
4846
+ def FlowOperateLimit(self, FlowOperateLimit):
4847
+ self._FlowOperateLimit = FlowOperateLimit
4848
+
4835
4849
 
4836
4850
  def _deserialize(self, params):
4837
4851
  if params.get("Agent") is not None:
@@ -4877,6 +4891,9 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4877
4891
  self._PreviewType = params.get("PreviewType")
4878
4892
  self._OpenDynamicFlow = params.get("OpenDynamicFlow")
4879
4893
  self._OpenDynamicSignFlow = params.get("OpenDynamicSignFlow")
4894
+ if params.get("FlowOperateLimit") is not None:
4895
+ self._FlowOperateLimit = FlowOperateLimit()
4896
+ self._FlowOperateLimit._deserialize(params.get("FlowOperateLimit"))
4880
4897
  memeber_set = set(params.keys())
4881
4898
  for name, value in vars(self).items():
4882
4899
  property_name = name[1:]
@@ -24339,85 +24356,38 @@ class FlowInfo(AbstractModel):
24339
24356
 
24340
24357
  def __init__(self):
24341
24358
  r"""
24342
- :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
24359
+ :param _FlowName: <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
24343
24360
  :type FlowName: str
24344
- :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
24345
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
24346
- 示例值:1604912664
24361
+ :param _Deadline: <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。<br>示例值:1604912664</p>
24347
24362
  :type Deadline: int
24348
- :param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
24349
- 如果使用模板发起接口,此参数为必填。
24350
-
24351
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
24352
-
24353
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
24354
-
24363
+ :param _TemplateId: <p>用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。<br>如果使用模板发起接口,此参数为必填。</p><p>可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在<strong>企业模板</strong>中得到合同模板ID。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png">点击产看模板Id在控制台上的位置</a></p>
24355
24364
  :type TemplateId: str
24356
- :param _FlowApprovers: 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
24357
-
24358
- 注:
24359
- <font color="red" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
24360
- 例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
24361
-
24362
- [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
24363
-
24365
+ :param _FlowApprovers: <p>合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a></p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png">点击查看模板参与人顺序定义位置</a></p>
24364
24366
  :type FlowApprovers: list of FlowApproverInfo
24365
- :param _FormFields: 发起方角色的填写控件的填充内容。
24366
-
24367
- 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。
24368
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
24367
+ :param _FormFields: <p>发起方角色的填写控件的填充内容。</p><p>注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png" alt="image"></p>
24369
24368
  :type FormFields: list of FormField
24370
- :param _CallbackUrl: 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
24369
+ :param _CallbackUrl: <p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
24371
24370
  :type CallbackUrl: str
24372
- :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
24371
+ :param _FlowType: <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
24373
24372
  :type FlowType: str
24374
- :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
24373
+ :param _FlowDescription: <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
24375
24374
  :type FlowDescription: str
24376
- :param _CustomerData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
24377
-
24378
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
24375
+ :param _CustomerData: <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
24379
24376
  :type CustomerData: str
24380
- :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
24381
- <ul><li>{合同名称} </li>
24382
- <li>{发起方企业} </li>
24383
- <li>{发起方姓名} </li>
24384
- <li>{签署方N企业}</li>
24385
- <li>{签署方N姓名}</li></ul>
24386
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
24387
-
24388
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
24389
-
24390
- 合同名称:租房合同
24391
- 发起方:腾讯公司(张三)
24392
- 签署方:李四
24393
-
24394
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
24395
-
24377
+ :param _CustomShowMap: <p>您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
24396
24378
  :type CustomShowMap: str
24397
- :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
24398
-
24399
- <b>注</b>
24400
- 1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
24401
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
24379
+ :param _CcInfos: <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
24402
24380
  :type CcInfos: list of CcInfo
24403
- :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
24404
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
24405
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
24406
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
24407
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
24408
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
24409
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
24381
+ :param _NeedSignReview: <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
24410
24382
  :type NeedSignReview: bool
24411
- :param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
24412
- <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
24413
- <li> **1** : 签署完成后通知对方来查看合同</li></ul>
24383
+ :param _CcNotifyType: <p>若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:</p><ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li><li> **1** : 签署完成后通知对方来查看合同</li></ul>
24414
24384
  :type CcNotifyType: int
24415
- :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
24416
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
24417
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
24385
+ :param _AutoSignScene: <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
24418
24386
  :type AutoSignScene: str
24419
- :param _FlowDisplayType: 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
24387
+ :param _FlowDisplayType: <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
24420
24388
  :type FlowDisplayType: int
24389
+ :param _FlowOperateLimit: <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p><p> 注:此参数目前<strong>只支持 CreateFlowsByTemplates接口</strong> 。</p>
24390
+ :type FlowOperateLimit: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
24421
24391
  """
24422
24392
  self._FlowName = None
24423
24393
  self._Deadline = None
@@ -24434,10 +24404,11 @@ class FlowInfo(AbstractModel):
24434
24404
  self._CcNotifyType = None
24435
24405
  self._AutoSignScene = None
24436
24406
  self._FlowDisplayType = None
24407
+ self._FlowOperateLimit = None
24437
24408
 
24438
24409
  @property
24439
24410
  def FlowName(self):
24440
- r"""合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
24411
+ r"""<p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
24441
24412
  :rtype: str
24442
24413
  """
24443
24414
  return self._FlowName
@@ -24448,9 +24419,7 @@ class FlowInfo(AbstractModel):
24448
24419
 
24449
24420
  @property
24450
24421
  def Deadline(self):
24451
- r"""合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
24452
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
24453
- 示例值:1604912664
24422
+ r"""<p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。<br>示例值:1604912664</p>
24454
24423
  :rtype: int
24455
24424
  """
24456
24425
  return self._Deadline
@@ -24461,13 +24430,7 @@ class FlowInfo(AbstractModel):
24461
24430
 
24462
24431
  @property
24463
24432
  def TemplateId(self):
24464
- r"""用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
24465
- 如果使用模板发起接口,此参数为必填。
24466
-
24467
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
24468
-
24469
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
24470
-
24433
+ r"""<p>用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。<br>如果使用模板发起接口,此参数为必填。</p><p>可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在<strong>企业模板</strong>中得到合同模板ID。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png">点击产看模板Id在控制台上的位置</a></p>
24471
24434
  :rtype: str
24472
24435
  """
24473
24436
  return self._TemplateId
@@ -24478,14 +24441,7 @@ class FlowInfo(AbstractModel):
24478
24441
 
24479
24442
  @property
24480
24443
  def FlowApprovers(self):
24481
- r"""合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
24482
-
24483
- 注:
24484
- <font color="red" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
24485
- 例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
24486
-
24487
- [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
24488
-
24444
+ r"""<p>合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a></p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png">点击查看模板参与人顺序定义位置</a></p>
24489
24445
  :rtype: list of FlowApproverInfo
24490
24446
  """
24491
24447
  return self._FlowApprovers
@@ -24496,10 +24452,7 @@ class FlowInfo(AbstractModel):
24496
24452
 
24497
24453
  @property
24498
24454
  def FormFields(self):
24499
- r"""发起方角色的填写控件的填充内容。
24500
-
24501
- 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。
24502
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
24455
+ r"""<p>发起方角色的填写控件的填充内容。</p><p>注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png" alt="image"></p>
24503
24456
  :rtype: list of FormField
24504
24457
  """
24505
24458
  return self._FormFields
@@ -24512,7 +24465,7 @@ class FlowInfo(AbstractModel):
24512
24465
  def CallbackUrl(self):
24513
24466
  warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
24514
24467
 
24515
- r"""该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
24468
+ r"""<p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
24516
24469
  :rtype: str
24517
24470
  """
24518
24471
  return self._CallbackUrl
@@ -24525,7 +24478,7 @@ class FlowInfo(AbstractModel):
24525
24478
 
24526
24479
  @property
24527
24480
  def FlowType(self):
24528
- r"""合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
24481
+ r"""<p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
24529
24482
  :rtype: str
24530
24483
  """
24531
24484
  return self._FlowType
@@ -24536,7 +24489,7 @@ class FlowInfo(AbstractModel):
24536
24489
 
24537
24490
  @property
24538
24491
  def FlowDescription(self):
24539
- r"""合同流程描述信息(可自定义此描述),最大长度1000个字符。
24492
+ r"""<p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
24540
24493
  :rtype: str
24541
24494
  """
24542
24495
  return self._FlowDescription
@@ -24547,9 +24500,7 @@ class FlowInfo(AbstractModel):
24547
24500
 
24548
24501
  @property
24549
24502
  def CustomerData(self):
24550
- r"""调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
24551
-
24552
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
24503
+ r"""<p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
24553
24504
  :rtype: str
24554
24505
  """
24555
24506
  return self._CustomerData
@@ -24560,22 +24511,7 @@ class FlowInfo(AbstractModel):
24560
24511
 
24561
24512
  @property
24562
24513
  def CustomShowMap(self):
24563
- r"""您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
24564
- <ul><li>{合同名称} </li>
24565
- <li>{发起方企业} </li>
24566
- <li>{发起方姓名} </li>
24567
- <li>{签署方N企业}</li>
24568
- <li>{签署方N姓名}</li></ul>
24569
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
24570
-
24571
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
24572
-
24573
- 合同名称:租房合同
24574
- 发起方:腾讯公司(张三)
24575
- 签署方:李四
24576
-
24577
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
24578
-
24514
+ r"""<p>您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
24579
24515
  :rtype: str
24580
24516
  """
24581
24517
  return self._CustomShowMap
@@ -24586,11 +24522,7 @@ class FlowInfo(AbstractModel):
24586
24522
 
24587
24523
  @property
24588
24524
  def CcInfos(self):
24589
- r"""合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
24590
-
24591
- <b>注</b>
24592
- 1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
24593
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
24525
+ r"""<p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
24594
24526
  :rtype: list of CcInfo
24595
24527
  """
24596
24528
  return self._CcInfos
@@ -24601,13 +24533,7 @@ class FlowInfo(AbstractModel):
24601
24533
 
24602
24534
  @property
24603
24535
  def NeedSignReview(self):
24604
- r"""发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
24605
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
24606
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
24607
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
24608
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
24609
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
24610
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
24536
+ r"""<p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
24611
24537
  :rtype: bool
24612
24538
  """
24613
24539
  return self._NeedSignReview
@@ -24618,9 +24544,7 @@ class FlowInfo(AbstractModel):
24618
24544
 
24619
24545
  @property
24620
24546
  def CcNotifyType(self):
24621
- r"""若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
24622
- <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
24623
- <li> **1** : 签署完成后通知对方来查看合同</li></ul>
24547
+ r"""<p>若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:</p><ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li><li> **1** : 签署完成后通知对方来查看合同</li></ul>
24624
24548
  :rtype: int
24625
24549
  """
24626
24550
  return self._CcNotifyType
@@ -24631,9 +24555,7 @@ class FlowInfo(AbstractModel):
24631
24555
 
24632
24556
  @property
24633
24557
  def AutoSignScene(self):
24634
- r"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
24635
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
24636
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
24558
+ r"""<p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
24637
24559
  :rtype: str
24638
24560
  """
24639
24561
  return self._AutoSignScene
@@ -24644,7 +24566,7 @@ class FlowInfo(AbstractModel):
24644
24566
 
24645
24567
  @property
24646
24568
  def FlowDisplayType(self):
24647
- r"""在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
24569
+ r"""<p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
24648
24570
  :rtype: int
24649
24571
  """
24650
24572
  return self._FlowDisplayType
@@ -24653,6 +24575,17 @@ class FlowInfo(AbstractModel):
24653
24575
  def FlowDisplayType(self, FlowDisplayType):
24654
24576
  self._FlowDisplayType = FlowDisplayType
24655
24577
 
24578
+ @property
24579
+ def FlowOperateLimit(self):
24580
+ r"""<p>发起合同流程时对合同流程的部分操作加以限制的配置。</p><p> 注:此参数目前<strong>只支持 CreateFlowsByTemplates接口</strong> 。</p>
24581
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
24582
+ """
24583
+ return self._FlowOperateLimit
24584
+
24585
+ @FlowOperateLimit.setter
24586
+ def FlowOperateLimit(self, FlowOperateLimit):
24587
+ self._FlowOperateLimit = FlowOperateLimit
24588
+
24656
24589
 
24657
24590
  def _deserialize(self, params):
24658
24591
  self._FlowName = params.get("FlowName")
@@ -24685,6 +24618,45 @@ class FlowInfo(AbstractModel):
24685
24618
  self._CcNotifyType = params.get("CcNotifyType")
24686
24619
  self._AutoSignScene = params.get("AutoSignScene")
24687
24620
  self._FlowDisplayType = params.get("FlowDisplayType")
24621
+ if params.get("FlowOperateLimit") is not None:
24622
+ self._FlowOperateLimit = FlowOperateLimit()
24623
+ self._FlowOperateLimit._deserialize(params.get("FlowOperateLimit"))
24624
+ memeber_set = set(params.keys())
24625
+ for name, value in vars(self).items():
24626
+ property_name = name[1:]
24627
+ if property_name in memeber_set:
24628
+ memeber_set.remove(property_name)
24629
+ if len(memeber_set) > 0:
24630
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
24631
+
24632
+
24633
+
24634
+ class FlowOperateLimit(AbstractModel):
24635
+ r"""发起合同流程时对合同流程的部分操作加以限制的配置。
24636
+
24637
+ """
24638
+
24639
+ def __init__(self):
24640
+ r"""
24641
+ :param _NoRelease: <p>发起合同流程时,对签署完成后是否能发起对应的解除合同加以限制:<ul><li><b>false(默认值)</b>: 合同流程完成签署后,支持发起对应的解除协议。</li><li><b>true </b>: 合同流程完成签署后,<b>不支持</b>发起对应的解除协议。</li></ul></p>
24642
+ :type NoRelease: bool
24643
+ """
24644
+ self._NoRelease = None
24645
+
24646
+ @property
24647
+ def NoRelease(self):
24648
+ r"""<p>发起合同流程时,对签署完成后是否能发起对应的解除合同加以限制:<ul><li><b>false(默认值)</b>: 合同流程完成签署后,支持发起对应的解除协议。</li><li><b>true </b>: 合同流程完成签署后,<b>不支持</b>发起对应的解除协议。</li></ul></p>
24649
+ :rtype: bool
24650
+ """
24651
+ return self._NoRelease
24652
+
24653
+ @NoRelease.setter
24654
+ def NoRelease(self, NoRelease):
24655
+ self._NoRelease = NoRelease
24656
+
24657
+
24658
+ def _deserialize(self, params):
24659
+ self._NoRelease = params.get("NoRelease")
24688
24660
  memeber_set = set(params.keys())
24689
24661
  for name, value in vars(self).items():
24690
24662
  property_name = name[1:]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.1.51
3
+ Version: 3.1.58
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
@@ -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.51
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.58
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.58
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.51