tencentcloud-sdk-python-ess 3.1.129__tar.gz → 3.1.130__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 (17) hide show
  1. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/setup.py +1 -1
  3. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud/ess/v20201111/models.py +100 -370
  5. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
  6. tencentcloud_sdk_python_ess-3.1.130/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
  7. tencentcloud_sdk_python_ess-3.1.129/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
  8. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/README.rst +0 -0
  9. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/setup.cfg +0 -0
  10. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud/ess/__init__.py +0 -0
  11. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud/ess/v20201111/__init__.py +0 -0
  12. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
  13. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud/ess/v20201111/ess_client.py +0 -0
  14. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud/ess/v20201111/ess_client_async.py +0 -0
  15. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_ess-3.1.129 → tencentcloud_sdk_python_ess-3.1.130}/tencentcloud_sdk_python_ess.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.129
3
+ Version: 3.1.130
4
4
  Summary: Tencent Cloud Ess SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.129
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.130
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-ess',
11
- install_requires=["tencentcloud-sdk-python-common>=3.1.129,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.130,<4.0.0"],
12
12
 
13
13
  version=tencentcloud.__version__,
14
14
  description='Tencent Cloud Ess SDK for Python',
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.129'
17
+ __version__ = '3.1.130'
@@ -10387,125 +10387,55 @@ class CreateFlowByFilesRequest(AbstractModel):
10387
10387
 
10388
10388
  def __init__(self):
10389
10389
  r"""
10390
- :param _Operator: 本合同的发起人 <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
10391
-
10392
- 注: 支持填入集团子公司经办人 userId 代发合同。
10393
-
10390
+ :param _Operator: <p>本合同的发起人 <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
10394
10391
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
10395
- :param _FlowName: 自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
10396
-
10397
- 该名称还将用于合同签署完成后文件下载的默认文件名称。
10392
+ :param _FlowName: <p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&amp;)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
10398
10393
  :type FlowName: str
10399
- :param _FileIds: 本合同流程需包含的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
10400
-
10401
- 注: `目前,此接口仅支持单个文件发起。`
10394
+ :param _FileIds: <p>本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF文件资源编号。</p><p>注: <code>目前,此接口仅支持单个文件发起。</code></p>
10402
10395
  :type FileIds: list of str
10403
- :param _Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
10404
-
10405
- 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
10396
+ :param _Approvers: <p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。</p>
10406
10397
  :type Approvers: list of ApproverInfo
10407
- :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
10398
+ :param _FlowDescription: <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
10408
10399
  :type FlowDescription: str
10409
- :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
10410
- 如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。
10411
- ![image](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
10400
+ :param _FlowType: <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png" alt="image"></p>
10412
10401
  :type FlowType: str
10413
- :param _Components: 发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)
10414
- <ul><li> 单行文本控件 </li>
10415
- <li> 多行文本控件 </li>
10416
- <li> 勾选框控件 </li>
10417
- <li> 数字控件 </li>
10418
- <li> 图片控件 </li>
10419
- <li> 水印控件等 </li>
10420
- </ul>
10421
-
10422
- ![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
10402
+ :param _Components: <p>发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)</p><ul><li> 单行文本控件 </li><li> 多行文本控件 </li><li> 勾选框控件 </li><li> 数字控件 </li><li> 图片控件 </li><li> 水印控件等 </li></ul><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
10423
10403
  :type Components: list of Component
10424
- :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
10425
-
10426
- <b>注</b>
10427
- 1. 抄送人名单中可以包括自然人以及本企业的员工。
10428
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
10429
-
10404
+ :param _CcInfos: <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
10430
10405
  :type CcInfos: list of CcInfo
10431
- :param _CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
10432
- <ul><li> **0**:合同发起时通知(默认值)</li>
10433
- <li> **1**:签署完成后通知</li></ul>
10406
+ :param _CcNotifyType: <p>可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:</p><ul><li> **0**:合同发起时通知(默认值)</li><li> **1**:签署完成后通知</li></ul>
10434
10407
  :type CcNotifyType: int
10435
- :param _NeedPreview: 是否为预览模式,取值如下:
10436
- <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
10437
- <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
10408
+ :param _NeedPreview: <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
10438
10409
  :type NeedPreview: bool
10439
- :param _PreviewType: 预览模式下产生的预览链接类型
10440
- <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
10441
- <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
10442
- 注: `此参数在NeedPreview 为true时有效`
10443
-
10410
+ :param _PreviewType: <p>预览模式下产生的预览链接类型 </p><ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code>
10444
10411
  :type PreviewType: int
10445
- :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
10446
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
10412
+ :param _Deadline: <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
10447
10413
  :type Deadline: int
10448
- :param _Unordered: 合同流程的签署顺序类型:
10449
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
10450
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
10414
+ :param _Unordered: <p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
10451
10415
  :type Unordered: bool
10452
- :param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
10453
-
10454
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
10416
+ :param _UserData: <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。</p>
10455
10417
  :type UserData: str
10456
- :param _RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
10457
-
10458
- 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
10418
+ :param _RemindedOn: <p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
10459
10419
  :type RemindedOn: int
10460
- :param _ApproverVerifyType: 指定个人签署方查看合同的校验方式<ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能查看合同内容 </li><li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
10420
+ :param _ApproverVerifyType: <p>指定个人签署方查看合同的校验方式<ul><li> <strong>VerifyCheck</strong> :(默认)人脸识别,人脸识别后才能查看合同内容 </li><li> <strong>MobileCheck</strong> : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul></p>
10461
10421
  :type ApproverVerifyType: str
10462
- :param _SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
10463
- <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
10464
- <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
10465
-
10466
- 注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5
10422
+ :param _SignBeanTag: <p>签署方签署控件(印章/签名等)的生成方式:</p><ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li><li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul><p>注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5</p>
10467
10423
  :type SignBeanTag: int
10468
- :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
10469
- <ul><li>{合同名称} </li>
10470
- <li>{发起方企业} </li>
10471
- <li>{发起方姓名} </li>
10472
- <li>{签署方N企业}</li>
10473
- <li>{签署方N姓名}</li></ul>
10474
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
10475
-
10476
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
10477
-
10478
- 合同名称:租房合同
10479
- 发起方:腾讯公司(张三)
10480
- 签署方:李四
10481
-
10482
-
10483
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
10484
-
10485
-
10424
+ :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>
10486
10425
  :type CustomShowMap: str
10487
- :param _Agent: 代理企业和员工的信息。
10488
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10426
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10489
10427
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
10490
- :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
10491
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
10492
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
10428
+ :param _AutoSignScene: <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
10493
10429
  :type AutoSignScene: str
10494
- :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
10495
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
10496
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
10497
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
10498
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
10499
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
10500
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
10430
+ :param _NeedSignReview: <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
10501
10431
  :type NeedSignReview: bool
10502
- :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)
10432
+ :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>
10503
10433
  :type FlowDisplayType: int
10504
- :param _OpenDynamicSignFlow: 是否开启动态签署合同:<ul><li> **true**:开启动态签署合同,可在发起时可以不传签署人,在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力) 。</li><li> **false**:不开启动态签署合同。</li></ul>
10434
+ :param _OpenDynamicSignFlow: <p>是否开启动态签署合同:<ul><li> <strong>true</strong>:开启动态签署合同,可在发起时可以不传签署人,在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力) 。</li><li> <strong>false</strong>:不开启动态签署合同。</li></ul></p>
10505
10435
  :type OpenDynamicSignFlow: bool
10506
- :param _Workflow: 是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流
10436
+ :param _Workflow: <p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
10507
10437
  :type Workflow: bool
10508
- :param _FlowOperateLimit: 发起合同流程时对合同流程的部分操作加以限制的配置。
10438
+ :param _FlowOperateLimit: <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
10509
10439
  :type FlowOperateLimit: :class:`tencentcloud.ess.v20201111.models.FlowOperateLimit`
10510
10440
  """
10511
10441
  self._Operator = None
@@ -10536,10 +10466,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10536
10466
 
10537
10467
  @property
10538
10468
  def Operator(self):
10539
- r"""本合同的发起人 <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
10540
-
10541
- 注: 支持填入集团子公司经办人 userId 代发合同。
10542
-
10469
+ r"""<p>本合同的发起人 <a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
10543
10470
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
10544
10471
  """
10545
10472
  return self._Operator
@@ -10550,9 +10477,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10550
10477
 
10551
10478
  @property
10552
10479
  def FlowName(self):
10553
- r"""自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
10554
-
10555
- 该名称还将用于合同签署完成后文件下载的默认文件名称。
10480
+ r"""<p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&amp;)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
10556
10481
  :rtype: str
10557
10482
  """
10558
10483
  return self._FlowName
@@ -10563,9 +10488,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10563
10488
 
10564
10489
  @property
10565
10490
  def FileIds(self):
10566
- r"""本合同流程需包含的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
10567
-
10568
- 注: `目前,此接口仅支持单个文件发起。`
10491
+ r"""<p>本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获取PDF文件资源编号。</p><p>注: <code>目前,此接口仅支持单个文件发起。</code></p>
10569
10492
  :rtype: list of str
10570
10493
  """
10571
10494
  return self._FileIds
@@ -10576,9 +10499,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10576
10499
 
10577
10500
  @property
10578
10501
  def Approvers(self):
10579
- r"""合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
10580
-
10581
- 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
10502
+ r"""<p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。</p>
10582
10503
  :rtype: list of ApproverInfo
10583
10504
  """
10584
10505
  return self._Approvers
@@ -10589,7 +10510,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10589
10510
 
10590
10511
  @property
10591
10512
  def FlowDescription(self):
10592
- r"""合同流程描述信息(可自定义此描述),最大长度1000个字符。
10513
+ r"""<p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
10593
10514
  :rtype: str
10594
10515
  """
10595
10516
  return self._FlowDescription
@@ -10600,9 +10521,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10600
10521
 
10601
10522
  @property
10602
10523
  def FlowType(self):
10603
- r"""合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
10604
- 如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。
10605
- ![image](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
10524
+ r"""<p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>如果用户已经在控制台创建了自定义合同类型,可以将这里的类型名称传入。 如果没有创建,我们会自动给发起方公司创建此自定义合同类型。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png" alt="image"></p>
10606
10525
  :rtype: str
10607
10526
  """
10608
10527
  return self._FlowType
@@ -10613,16 +10532,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10613
10532
 
10614
10533
  @property
10615
10534
  def Components(self):
10616
- r"""发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)
10617
- <ul><li> 单行文本控件 </li>
10618
- <li> 多行文本控件 </li>
10619
- <li> 勾选框控件 </li>
10620
- <li> 数字控件 </li>
10621
- <li> 图片控件 </li>
10622
- <li> 水印控件等 </li>
10623
- </ul>
10624
-
10625
- ![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
10535
+ r"""<p>发起的时候合成到PDF上的填写控件(需要提供填写控件的内容)</p><ul><li> 单行文本控件 </li><li> 多行文本控件 </li><li> 勾选框控件 </li><li> 数字控件 </li><li> 图片控件 </li><li> 水印控件等 </li></ul><p><img src="https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png" alt="image"></p>
10626
10536
  :rtype: list of Component
10627
10537
  """
10628
10538
  return self._Components
@@ -10633,12 +10543,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10633
10543
 
10634
10544
  @property
10635
10545
  def CcInfos(self):
10636
- r"""合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
10637
-
10638
- <b>注</b>
10639
- 1. 抄送人名单中可以包括自然人以及本企业的员工。
10640
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
10641
-
10546
+ r"""<p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
10642
10547
  :rtype: list of CcInfo
10643
10548
  """
10644
10549
  return self._CcInfos
@@ -10649,9 +10554,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10649
10554
 
10650
10555
  @property
10651
10556
  def CcNotifyType(self):
10652
- r"""可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
10653
- <ul><li> **0**:合同发起时通知(默认值)</li>
10654
- <li> **1**:签署完成后通知</li></ul>
10557
+ r"""<p>可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:</p><ul><li> **0**:合同发起时通知(默认值)</li><li> **1**:签署完成后通知</li></ul>
10655
10558
  :rtype: int
10656
10559
  """
10657
10560
  return self._CcNotifyType
@@ -10662,9 +10565,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10662
10565
 
10663
10566
  @property
10664
10567
  def NeedPreview(self):
10665
- r"""是否为预览模式,取值如下:
10666
- <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
10667
- <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
10568
+ r"""<p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
10668
10569
  :rtype: bool
10669
10570
  """
10670
10571
  return self._NeedPreview
@@ -10675,11 +10576,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10675
10576
 
10676
10577
  @property
10677
10578
  def PreviewType(self):
10678
- r"""预览模式下产生的预览链接类型
10679
- <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
10680
- <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
10681
- 注: `此参数在NeedPreview 为true时有效`
10682
-
10579
+ r"""<p>预览模式下产生的预览链接类型 </p><ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code>
10683
10580
  :rtype: int
10684
10581
  """
10685
10582
  return self._PreviewType
@@ -10690,8 +10587,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10690
10587
 
10691
10588
  @property
10692
10589
  def Deadline(self):
10693
- r"""合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
10694
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
10590
+ r"""<p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
10695
10591
  :rtype: int
10696
10592
  """
10697
10593
  return self._Deadline
@@ -10702,9 +10598,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10702
10598
 
10703
10599
  @property
10704
10600
  def Unordered(self):
10705
- r"""合同流程的签署顺序类型:
10706
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
10707
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
10601
+ r"""<p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
10708
10602
  :rtype: bool
10709
10603
  """
10710
10604
  return self._Unordered
@@ -10715,9 +10609,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10715
10609
 
10716
10610
  @property
10717
10611
  def UserData(self):
10718
- r"""调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
10719
-
10720
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
10612
+ r"""<p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2">回调通知</a>模块。</p>
10721
10613
  :rtype: str
10722
10614
  """
10723
10615
  return self._UserData
@@ -10728,9 +10620,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10728
10620
 
10729
10621
  @property
10730
10622
  def RemindedOn(self):
10731
- r"""合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
10732
-
10733
- 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
10623
+ r"""<p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
10734
10624
  :rtype: int
10735
10625
  """
10736
10626
  return self._RemindedOn
@@ -10741,7 +10631,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10741
10631
 
10742
10632
  @property
10743
10633
  def ApproverVerifyType(self):
10744
- r"""指定个人签署方查看合同的校验方式<ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能查看合同内容 </li><li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>
10634
+ r"""<p>指定个人签署方查看合同的校验方式<ul><li> <strong>VerifyCheck</strong> :(默认)人脸识别,人脸识别后才能查看合同内容 </li><li> <strong>MobileCheck</strong> : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul></p>
10745
10635
  :rtype: str
10746
10636
  """
10747
10637
  return self._ApproverVerifyType
@@ -10752,11 +10642,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10752
10642
 
10753
10643
  @property
10754
10644
  def SignBeanTag(self):
10755
- r"""签署方签署控件(印章/签名等)的生成方式:
10756
- <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
10757
- <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
10758
-
10759
- 注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5
10645
+ r"""<p>签署方签署控件(印章/签名等)的生成方式:</p><ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li><li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul><p>注:签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署,不支持H5</p>
10760
10646
  :rtype: int
10761
10647
  """
10762
10648
  return self._SignBeanTag
@@ -10767,24 +10653,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10767
10653
 
10768
10654
  @property
10769
10655
  def CustomShowMap(self):
10770
- r"""您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
10771
- <ul><li>{合同名称} </li>
10772
- <li>{发起方企业} </li>
10773
- <li>{发起方姓名} </li>
10774
- <li>{签署方N企业}</li>
10775
- <li>{签署方N姓名}</li></ul>
10776
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
10777
-
10778
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
10779
-
10780
- 合同名称:租房合同
10781
- 发起方:腾讯公司(张三)
10782
- 签署方:李四
10783
-
10784
-
10785
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
10786
-
10787
-
10656
+ 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>
10788
10657
  :rtype: str
10789
10658
  """
10790
10659
  return self._CustomShowMap
@@ -10795,8 +10664,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10795
10664
 
10796
10665
  @property
10797
10666
  def Agent(self):
10798
- r"""代理企业和员工的信息。
10799
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10667
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10800
10668
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
10801
10669
  """
10802
10670
  return self._Agent
@@ -10807,9 +10675,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10807
10675
 
10808
10676
  @property
10809
10677
  def AutoSignScene(self):
10810
- r"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
10811
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
10812
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
10678
+ r"""<p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
10813
10679
  :rtype: str
10814
10680
  """
10815
10681
  return self._AutoSignScene
@@ -10820,13 +10686,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10820
10686
 
10821
10687
  @property
10822
10688
  def NeedSignReview(self):
10823
- r"""发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
10824
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
10825
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
10826
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
10827
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
10828
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
10829
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
10689
+ r"""<p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
10830
10690
  :rtype: bool
10831
10691
  """
10832
10692
  return self._NeedSignReview
@@ -10837,7 +10697,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10837
10697
 
10838
10698
  @property
10839
10699
  def FlowDisplayType(self):
10840
- 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)
10700
+ 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>
10841
10701
  :rtype: int
10842
10702
  """
10843
10703
  return self._FlowDisplayType
@@ -10848,7 +10708,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10848
10708
 
10849
10709
  @property
10850
10710
  def OpenDynamicSignFlow(self):
10851
- r"""是否开启动态签署合同:<ul><li> **true**:开启动态签署合同,可在发起时可以不传签署人,在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力) 。</li><li> **false**:不开启动态签署合同。</li></ul>
10711
+ r"""<p>是否开启动态签署合同:<ul><li> <strong>true</strong>:开启动态签署合同,可在发起时可以不传签署人,在签署过程中追加签署人(必须满足:1,发起方企业开启了模块化计费能力;2,发起方企业在企业应用管理中开启了动态签署人2.0能力) 。</li><li> <strong>false</strong>:不开启动态签署合同。</li></ul></p>
10852
10712
  :rtype: bool
10853
10713
  """
10854
10714
  return self._OpenDynamicSignFlow
@@ -10859,7 +10719,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10859
10719
 
10860
10720
  @property
10861
10721
  def Workflow(self):
10862
- r"""是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流
10722
+ r"""<p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
10863
10723
  :rtype: bool
10864
10724
  """
10865
10725
  return self._Workflow
@@ -10870,7 +10730,7 @@ class CreateFlowByFilesRequest(AbstractModel):
10870
10730
 
10871
10731
  @property
10872
10732
  def FlowOperateLimit(self):
10873
- r"""发起合同流程时对合同流程的部分操作加以限制的配置。
10733
+ r"""<p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
10874
10734
  :rtype: :class:`tencentcloud.ess.v20201111.models.FlowOperateLimit`
10875
10735
  """
10876
10736
  return self._FlowOperateLimit
@@ -10944,20 +10804,13 @@ class CreateFlowByFilesResponse(AbstractModel):
10944
10804
 
10945
10805
  def __init__(self):
10946
10806
  r"""
10947
- :param _FlowId: 合同流程ID,为32位字符串。
10948
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
10949
-
10950
- 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
10951
-
10952
- [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
10807
+ :param _FlowId: <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
10953
10808
  :type FlowId: str
10954
- :param _PreviewUrl: 合同预览链接URL。
10955
-
10956
- 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
10809
+ :param _PreviewUrl: <p>合同预览链接URL。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL</p>
10957
10810
  :type PreviewUrl: str
10958
- :param _Approvers: 签署方信息,如角色ID、角色名称等
10811
+ :param _Approvers: <p>签署方信息,如角色ID、角色名称等</p>
10959
10812
  :type Approvers: list of ApproverItem
10960
- :param _WorkflowInstanceId: 发起审批流id,仅在CreateFlowByFiles时指定了WorkFlow=true时返回
10813
+ :param _WorkflowInstanceId: <p>发起审批流id,仅在CreateFlowByFiles时指定了WorkFlow=true时返回</p>
10961
10814
  :type WorkflowInstanceId: str
10962
10815
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10963
10816
  :type RequestId: str
@@ -10970,12 +10823,7 @@ class CreateFlowByFilesResponse(AbstractModel):
10970
10823
 
10971
10824
  @property
10972
10825
  def FlowId(self):
10973
- r"""合同流程ID,为32位字符串。
10974
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
10975
-
10976
- 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
10977
-
10978
- [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
10826
+ r"""<p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
10979
10827
  :rtype: str
10980
10828
  """
10981
10829
  return self._FlowId
@@ -10986,9 +10834,7 @@ class CreateFlowByFilesResponse(AbstractModel):
10986
10834
 
10987
10835
  @property
10988
10836
  def PreviewUrl(self):
10989
- r"""合同预览链接URL。
10990
-
10991
- 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
10837
+ r"""<p>合同预览链接URL。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL</p>
10992
10838
  :rtype: str
10993
10839
  """
10994
10840
  return self._PreviewUrl
@@ -10999,7 +10845,7 @@ class CreateFlowByFilesResponse(AbstractModel):
10999
10845
 
11000
10846
  @property
11001
10847
  def Approvers(self):
11002
- r"""签署方信息,如角色ID、角色名称等
10848
+ r"""<p>签署方信息,如角色ID、角色名称等</p>
11003
10849
  :rtype: list of ApproverItem
11004
10850
  """
11005
10851
  return self._Approvers
@@ -11010,7 +10856,7 @@ class CreateFlowByFilesResponse(AbstractModel):
11010
10856
 
11011
10857
  @property
11012
10858
  def WorkflowInstanceId(self):
11013
- r"""发起审批流id,仅在CreateFlowByFiles时指定了WorkFlow=true时返回
10859
+ r"""<p>发起审批流id,仅在CreateFlowByFiles时指定了WorkFlow=true时返回</p>
11014
10860
  :rtype: str
11015
10861
  """
11016
10862
  return self._WorkflowInstanceId
@@ -12943,97 +12789,45 @@ class CreateFlowRequest(AbstractModel):
12943
12789
 
12944
12790
  def __init__(self):
12945
12791
  r"""
12946
- :param _Operator: 本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
12947
-
12948
- 注: 支持填入集团子公司经办人 userId 代发合同。
12792
+ :param _Operator: <p>本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
12949
12793
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
12950
- :param _FlowName: 自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
12951
-
12952
- 该名称还将用于合同签署完成后文件下载的默认文件名称。
12794
+ :param _FlowName: <p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&amp;)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
12953
12795
  :type FlowName: str
12954
- :param _Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
12955
-
12956
- 注:
12957
- <font color="red" > <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。
12958
- 例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
12959
-
12960
- [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
12796
+ :param _Approvers: <p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png">点击查看模板参与人顺序定义位置</a></p>
12961
12797
  :type Approvers: list of FlowCreateApprover
12962
- :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
12798
+ :param _FlowDescription: <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
12963
12799
  :type FlowDescription: str
12964
- :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
12965
- 此合同类型需要跟模板配置的合同类型保持一致。
12800
+ :param _FlowType: <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>此合同类型需要跟模板配置的合同类型保持一致。</p>
12966
12801
  :type FlowType: str
12967
- :param _ClientToken: 该字段已不再使用
12802
+ :param _ClientToken: <p>该字段已不再使用</p>
12968
12803
  :type ClientToken: str
12969
- :param _DeadLine: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
12970
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
12804
+ :param _DeadLine: <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
12971
12805
  :type DeadLine: int
12972
- :param _RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
12973
-
12974
- 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
12806
+ :param _RemindedOn: <p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
12975
12807
  :type RemindedOn: int
12976
- :param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64格式编码,支持的最大数据大小为 20480长度。
12977
-
12978
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
12808
+ :param _UserData: <p>调用方自定义的个性化字段(可自定义此名称),并以base64格式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
12979
12809
  :type UserData: str
12980
- :param _Unordered: 合同流程的签署顺序类型:
12981
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
12982
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
12983
- 注:`请和模板中的配置保持一致`
12810
+ :param _Unordered: <p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>注:<code>请和模板中的配置保持一致</code>
12984
12811
  :type Unordered: bool
12985
- :param _CustomShowMap: 您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板,模板中支持以下变量:
12986
- <ul><li>{合同名称} </li>
12987
- <li>{发起方企业} </li>
12988
- <li>{发起方姓名} </li>
12989
- <li>{签署方N企业}</li>
12990
- <li>{签署方N姓名}</li></ul>
12991
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
12992
-
12993
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
12994
-
12995
- 合同名称:租房合同
12996
- 发起方:腾讯公司(张三)
12997
- 签署方:李四
12998
-
12999
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
13000
-
13001
-
12812
+ :param _CustomShowMap: <p>您可以自定义<strong>腾讯电子签小程序合同列表页</strong>展示的合同内容模板,模板中支持以下变量:</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>
13002
12813
  :type CustomShowMap: str
13003
- :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
13004
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
13005
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
13006
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
13007
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
13008
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
13009
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
12814
+ :param _NeedSignReview: <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
13010
12815
  :type NeedSignReview: bool
13011
- :param _Agent: 代理企业和员工的信息。
13012
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12816
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
13013
12817
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
13014
- :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
13015
-
13016
- <b>注</b>
13017
- 1. 抄送人名单中可以包括自然人以及本企业的员工。
13018
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
12818
+ :param _CcInfos: <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
13019
12819
  :type CcInfos: list of CcInfo
13020
- :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
13021
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
13022
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
12820
+ :param _AutoSignScene: <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
13023
12821
  :type AutoSignScene: str
13024
- :param _RelatedFlowId: 暂未开放
12822
+ :param _RelatedFlowId: <p>暂未开放</p>
13025
12823
  :type RelatedFlowId: str
13026
- :param _CallbackUrl: 暂未开放
12824
+ :param _CallbackUrl: <p>暂未开放</p>
13027
12825
  :type CallbackUrl: str
13028
- :param _FlowDisplayType: 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:
13029
- <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>
13030
-
13031
- 效果如下:
13032
- ![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
12826
+ :param _FlowDisplayType: <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:<br> <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
13033
12827
  :type FlowDisplayType: int
13034
- :param _Workflow: 是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流
12828
+ :param _Workflow: <p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
13035
12829
  :type Workflow: bool
13036
- :param _FlowOperateLimit: 发起合同流程时对合同流程的部分操作加以限制的配置。
12830
+ :param _FlowOperateLimit: <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
13037
12831
  :type FlowOperateLimit: :class:`tencentcloud.ess.v20201111.models.FlowOperateLimit`
13038
12832
  """
13039
12833
  self._Operator = None
@@ -13059,9 +12853,7 @@ class CreateFlowRequest(AbstractModel):
13059
12853
 
13060
12854
  @property
13061
12855
  def Operator(self):
13062
- r"""本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a>
13063
-
13064
- 注: 支持填入集团子公司经办人 userId 代发合同。
12856
+ r"""<p>本合同的发起人,<a href="https://qcloudimg.tencent-cloud.cn/raw/f850cfbe163a1cb38439a9f551c2505c.png" target="_blank">点击查看合同发起人展示的位置</a></p><p>注: 支持填入集团子公司经办人 userId 代发合同。</p>
13065
12857
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
13066
12858
  """
13067
12859
  return self._Operator
@@ -13072,9 +12864,7 @@ class CreateFlowRequest(AbstractModel):
13072
12864
 
13073
12865
  @property
13074
12866
  def FlowName(self):
13075
- r"""自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&)、(+)组成。
13076
-
13077
- 该名称还将用于合同签署完成后文件下载的默认文件名称。
12867
+ r"""<p>自定义的合同流程的名称,长度不能超过200个字符,只能由中文汉字、中文标点、英文字母、阿拉伯数字、空格、小括号、中括号、中划线、下划线以及(,)、(;)、(.)、(&amp;)、(+)组成。</p><p>该名称还将用于合同签署完成后文件下载的默认文件名称。</p>
13078
12868
  :rtype: str
13079
12869
  """
13080
12870
  return self._FlowName
@@ -13085,13 +12875,7 @@ class CreateFlowRequest(AbstractModel):
13085
12875
 
13086
12876
  @property
13087
12877
  def Approvers(self):
13088
- r"""合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
13089
-
13090
- 注:
13091
- <font color="red" > <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。
13092
- 例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
13093
-
13094
- [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png)
12878
+ r"""<p>合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。</p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 approver 中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/d14457b48cc66b29262ccb9d7b3ed556.png">点击查看模板参与人顺序定义位置</a></p>
13095
12879
  :rtype: list of FlowCreateApprover
13096
12880
  """
13097
12881
  return self._Approvers
@@ -13102,7 +12886,7 @@ class CreateFlowRequest(AbstractModel):
13102
12886
 
13103
12887
  @property
13104
12888
  def FlowDescription(self):
13105
- r"""合同流程描述信息(可自定义此描述),最大长度1000个字符。
12889
+ r"""<p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
13106
12890
  :rtype: str
13107
12891
  """
13108
12892
  return self._FlowDescription
@@ -13113,8 +12897,7 @@ class CreateFlowRequest(AbstractModel):
13113
12897
 
13114
12898
  @property
13115
12899
  def FlowType(self):
13116
- r"""合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
13117
- 此合同类型需要跟模板配置的合同类型保持一致。
12900
+ r"""<p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。<br>此合同类型需要跟模板配置的合同类型保持一致。</p>
13118
12901
  :rtype: str
13119
12902
  """
13120
12903
  return self._FlowType
@@ -13125,7 +12908,7 @@ class CreateFlowRequest(AbstractModel):
13125
12908
 
13126
12909
  @property
13127
12910
  def ClientToken(self):
13128
- r"""该字段已不再使用
12911
+ r"""<p>该字段已不再使用</p>
13129
12912
  :rtype: str
13130
12913
  """
13131
12914
  return self._ClientToken
@@ -13136,8 +12919,7 @@ class CreateFlowRequest(AbstractModel):
13136
12919
 
13137
12920
  @property
13138
12921
  def DeadLine(self):
13139
- r"""合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
13140
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
12922
+ r"""<p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
13141
12923
  :rtype: int
13142
12924
  """
13143
12925
  return self._DeadLine
@@ -13148,9 +12930,7 @@ class CreateFlowRequest(AbstractModel):
13148
12930
 
13149
12931
  @property
13150
12932
  def RemindedOn(self):
13151
- r"""合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
13152
-
13153
- 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
12933
+ r"""<p>合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。</p><p>到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。</p>
13154
12934
  :rtype: int
13155
12935
  """
13156
12936
  return self._RemindedOn
@@ -13161,9 +12941,7 @@ class CreateFlowRequest(AbstractModel):
13161
12941
 
13162
12942
  @property
13163
12943
  def UserData(self):
13164
- r"""调用方自定义的个性化字段(可自定义此名称),并以base64格式编码,支持的最大数据大小为 20480长度。
13165
-
13166
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
12944
+ r"""<p>调用方自定义的个性化字段(可自定义此名称),并以base64格式编码,支持的最大数据大小为 20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
13167
12945
  :rtype: str
13168
12946
  """
13169
12947
  return self._UserData
@@ -13174,10 +12952,7 @@ class CreateFlowRequest(AbstractModel):
13174
12952
 
13175
12953
  @property
13176
12954
  def Unordered(self):
13177
- r"""合同流程的签署顺序类型:
13178
- <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
13179
- <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
13180
- 注:`请和模板中的配置保持一致`
12955
+ r"""<p>合同流程的签署顺序类型:</p><ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li><li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>注:<code>请和模板中的配置保持一致</code>
13181
12956
  :rtype: bool
13182
12957
  """
13183
12958
  return self._Unordered
@@ -13188,23 +12963,7 @@ class CreateFlowRequest(AbstractModel):
13188
12963
 
13189
12964
  @property
13190
12965
  def CustomShowMap(self):
13191
- r"""您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板,模板中支持以下变量:
13192
- <ul><li>{合同名称} </li>
13193
- <li>{发起方企业} </li>
13194
- <li>{发起方姓名} </li>
13195
- <li>{签署方N企业}</li>
13196
- <li>{签署方N姓名}</li></ul>
13197
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
13198
-
13199
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
13200
-
13201
- 合同名称:租房合同
13202
- 发起方:腾讯公司(张三)
13203
- 签署方:李四
13204
-
13205
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
13206
-
13207
-
12966
+ r"""<p>您可以自定义<strong>腾讯电子签小程序合同列表页</strong>展示的合同内容模板,模板中支持以下变量:</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>
13208
12967
  :rtype: str
13209
12968
  """
13210
12969
  return self._CustomShowMap
@@ -13215,13 +12974,7 @@ class CreateFlowRequest(AbstractModel):
13215
12974
 
13216
12975
  @property
13217
12976
  def NeedSignReview(self):
13218
- r"""发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
13219
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
13220
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
13221
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
13222
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
13223
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
13224
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
12977
+ r"""<p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
13225
12978
  :rtype: bool
13226
12979
  """
13227
12980
  return self._NeedSignReview
@@ -13232,8 +12985,7 @@ class CreateFlowRequest(AbstractModel):
13232
12985
 
13233
12986
  @property
13234
12987
  def Agent(self):
13235
- r"""代理企业和员工的信息。
13236
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12988
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
13237
12989
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
13238
12990
  """
13239
12991
  return self._Agent
@@ -13244,11 +12996,7 @@ class CreateFlowRequest(AbstractModel):
13244
12996
 
13245
12997
  @property
13246
12998
  def CcInfos(self):
13247
- r"""合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
13248
-
13249
- <b>注</b>
13250
- 1. 抄送人名单中可以包括自然人以及本企业的员工。
13251
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
12999
+ r"""<p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
13252
13000
  :rtype: list of CcInfo
13253
13001
  """
13254
13002
  return self._CcInfos
@@ -13259,9 +13007,7 @@ class CreateFlowRequest(AbstractModel):
13259
13007
 
13260
13008
  @property
13261
13009
  def AutoSignScene(self):
13262
- r"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
13263
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
13264
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
13010
+ r"""<p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
13265
13011
  :rtype: str
13266
13012
  """
13267
13013
  return self._AutoSignScene
@@ -13274,7 +13020,7 @@ class CreateFlowRequest(AbstractModel):
13274
13020
  def RelatedFlowId(self):
13275
13021
  warnings.warn("parameter `RelatedFlowId` is deprecated", DeprecationWarning)
13276
13022
 
13277
- r"""暂未开放
13023
+ r"""<p>暂未开放</p>
13278
13024
  :rtype: str
13279
13025
  """
13280
13026
  return self._RelatedFlowId
@@ -13289,7 +13035,7 @@ class CreateFlowRequest(AbstractModel):
13289
13035
  def CallbackUrl(self):
13290
13036
  warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
13291
13037
 
13292
- r"""暂未开放
13038
+ r"""<p>暂未开放</p>
13293
13039
  :rtype: str
13294
13040
  """
13295
13041
  return self._CallbackUrl
@@ -13302,11 +13048,7 @@ class CreateFlowRequest(AbstractModel):
13302
13048
 
13303
13049
  @property
13304
13050
  def FlowDisplayType(self):
13305
- r"""在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:
13306
- <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>
13307
-
13308
- 效果如下:
13309
- ![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
13051
+ r"""<p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:<br> <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
13310
13052
  :rtype: int
13311
13053
  """
13312
13054
  return self._FlowDisplayType
@@ -13317,7 +13059,7 @@ class CreateFlowRequest(AbstractModel):
13317
13059
 
13318
13060
  @property
13319
13061
  def Workflow(self):
13320
- r"""是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流
13062
+ r"""<p>是否开启发起合同审批,默认:false(不开启),开启后,发起合同(StartFlow),会提交电子签内置的审批流</p>
13321
13063
  :rtype: bool
13322
13064
  """
13323
13065
  return self._Workflow
@@ -13328,7 +13070,7 @@ class CreateFlowRequest(AbstractModel):
13328
13070
 
13329
13071
  @property
13330
13072
  def FlowOperateLimit(self):
13331
- r"""发起合同流程时对合同流程的部分操作加以限制的配置。
13073
+ r"""<p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
13332
13074
  :rtype: :class:`tencentcloud.ess.v20201111.models.FlowOperateLimit`
13333
13075
  """
13334
13076
  return self._FlowOperateLimit
@@ -13392,13 +13134,7 @@ class CreateFlowResponse(AbstractModel):
13392
13134
 
13393
13135
  def __init__(self):
13394
13136
  r"""
13395
- :param _FlowId: 合同流程ID,为32位字符串。
13396
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
13397
-
13398
- 注:
13399
- 此返回的合同流程ID,需再次调用<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>接口将合同开始后,合同才能进入签署环节,[点击查看FlowId在控制台中的位置(只在进入签署环节后有效)](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
13400
-
13401
-
13137
+ :param _FlowId: <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注:<br>此返回的合同流程ID,需再次调用<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>接口将合同开始后,合同才能进入签署环节,<a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置(只在进入签署环节后有效)</a></p>
13402
13138
  :type FlowId: str
13403
13139
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13404
13140
  :type RequestId: str
@@ -13408,13 +13144,7 @@ class CreateFlowResponse(AbstractModel):
13408
13144
 
13409
13145
  @property
13410
13146
  def FlowId(self):
13411
- r"""合同流程ID,为32位字符串。
13412
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
13413
-
13414
- 注:
13415
- 此返回的合同流程ID,需再次调用<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>接口将合同开始后,合同才能进入签署环节,[点击查看FlowId在控制台中的位置(只在进入签署环节后有效)](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
13416
-
13417
-
13147
+ r"""<p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</p><p>注:<br>此返回的合同流程ID,需再次调用<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>接口将合同开始后,合同才能进入签署环节,<a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置(只在进入签署环节后有效)</a></p>
13418
13148
  :rtype: str
13419
13149
  """
13420
13150
  return self._FlowId
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.129
3
+ Version: 3.1.130
4
4
  Summary: Tencent Cloud Ess SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.129
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.130
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.130
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.129