tencentcloud-sdk-python-essbasic 3.0.1037__tar.gz → 3.0.1039__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 (20) hide show
  1. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/setup.py +1 -1
  3. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20210526/essbasic_client.py +20 -7
  5. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20210526/models.py +186 -72
  6. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
  7. tencentcloud-sdk-python-essbasic-3.0.1039/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  8. tencentcloud-sdk-python-essbasic-3.0.1037/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  9. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/README.rst +0 -0
  10. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/setup.cfg +0 -0
  11. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/__init__.py +0 -0
  12. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  13. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  15. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-essbasic-3.0.1037 → tencentcloud-sdk-python-essbasic-3.0.1039}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1037
3
+ Version: 3.0.1039
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
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-essbasic',
11
- install_requires=["tencentcloud-sdk-python-common==3.0.1037"],
11
+ install_requires=["tencentcloud-sdk-python-common==3.0.1039"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Essbasic SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1037'
17
+ __version__ = '3.0.1039'
@@ -302,8 +302,13 @@ class EssbasicClient(AbstractClient):
302
302
 
303
303
  def ChannelCreateEmbedWebUrl(self, request):
304
304
  """本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
305
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
306
- 进入web连接后与当前控制台操作保持一致
305
+
306
+ 本接口下面功能的签署页面链接的生成
307
+ - 创建印章
308
+ - 创建模板
309
+ - 修改模板
310
+ - 预览模板
311
+ - 预览合同流程
307
312
 
308
313
  :param request: Request instance for ChannelCreateEmbedWebUrl.
309
314
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateEmbedWebUrlRequest`
@@ -778,11 +783,14 @@ class EssbasicClient(AbstractClient):
778
783
 
779
784
 
780
785
  def ChannelCreatePrepareFlow(self, request):
781
- """创建预发起合同
782
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
783
- 可指定合同信息不可更改,签署人信息不可更改
784
- 合同发起后,填写及签署流程与现有操作流程一致
785
- 注意:目前仅支持模板发起
786
+ """通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
787
+
788
+ 注意:
789
+ 1. **仅支持模板**发起
790
+ 2. 只支持PC浏览器操作使用
791
+
792
+ 嵌入的页面样式如下:
793
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
786
794
 
787
795
  :param request: Request instance for ChannelCreatePrepareFlow.
788
796
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreatePrepareFlowRequest`
@@ -1450,6 +1458,11 @@ class EssbasicClient(AbstractClient):
1450
1458
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
1451
1459
  </ul>
1452
1460
 
1461
+
1462
+ 注意:
1463
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
1464
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
1465
+
1453
1466
  :param request: Request instance for CreateChannelOrganizationInfoChangeUrl.
1454
1467
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelOrganizationInfoChangeUrlRequest`
1455
1468
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelOrganizationInfoChangeUrlResponse`
@@ -501,7 +501,7 @@ class AutoSignConfig(AbstractModel):
501
501
  :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
502
502
 
503
503
  <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
504
- </ul>
504
+ <li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
505
505
  :type LicenseType: int
506
506
  """
507
507
  self._UserInfo = None
@@ -596,35 +596,43 @@ class BaseFlowInfo(AbstractModel):
596
596
 
597
597
  def __init__(self):
598
598
  r"""
599
- :param _FlowName: 合同流程名称
599
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
600
600
  :type FlowName: str
601
- :param _FlowType: 合同流程类型
602
- <br/>客户自定义,用于合同分类展示
601
+ :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
603
602
  :type FlowType: str
604
- :param _FlowDescription: 合同流程描述信息
603
+ :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
605
604
  :type FlowDescription: str
606
- :param _Deadline: 合同流程截止时间,unix时间戳,单位秒
605
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
607
606
  :type Deadline: int
608
- :param _Unordered: 是否顺序签署(true:无序签,false:顺序签)
609
- <br/>默认false,有序签署合同
607
+ :param _Unordered: 合同流程的签署顺序类型:
608
+ **false**:(默认)有序签署, 本合同多个参与人需要依次签署
609
+ **true**:无序签署, 本合同多个参与人没有先后签署限制
610
610
  :type Unordered: bool
611
611
  :param _IntelligentStatus: 是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
612
612
  :type IntelligentStatus: str
613
- :param _FormFields: 填写控件内容
613
+ :param _FormFields: 填写控件内容, 填写的控制的ID-填写的内容对列表
614
614
  :type FormFields: list of FormField
615
- :param _NeedSignReview: 本企业(发起方企业)是否需要签署审批
616
- <br/>true:开启发起方签署审批
617
- <br/>false:不开启发起方签署审批
618
- <br/>开启后,使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
615
+ :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
616
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
617
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
618
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
619
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
620
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
621
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
619
622
  :type NeedSignReview: bool
620
- :param _UserData: 用户流程自定义数据参数
623
+ :param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
624
+
625
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
621
626
  :type UserData: str
622
- :param _CcInfos: 抄送人信息
627
+ :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
628
+
629
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
623
630
  :type CcInfos: list of CcInfo
624
- :param _NeedCreateReview: 是否需要开启发起方发起前审核
625
- <br/>true:开启发起方发起前审核
626
- <br/>false:不开启发起方发起前审核
627
- <br/>当指定NeedCreateReview=true,则提交审核后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
631
+ :param _NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
632
+
633
+ 若设置为true,发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
634
+
635
+
628
636
  :type NeedCreateReview: bool
629
637
  :param _Components: 填写控件:文件发起使用
630
638
  :type Components: list of Component
@@ -1618,7 +1626,8 @@ class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
1618
1626
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1619
1627
  :param _Operator: 操作人信息
1620
1628
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
1621
- :param _SceneKey: 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
1629
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
1630
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
1622
1631
  :type SceneKey: str
1623
1632
  :param _UserInfo: 指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
1624
1633
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -2511,25 +2520,37 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2511
2520
 
2512
2521
  def __init__(self):
2513
2522
  r"""
2514
- :param _Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
2523
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2524
+
2525
+ 此接口下面信息必填。
2526
+ <ul>
2527
+ <li>渠道应用标识: Agent.AppId</li>
2528
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2529
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2530
+ </ul>
2531
+ 第三方平台子客企业和员工必须已经经过实名认证
2515
2532
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2516
2533
  :param _EmbedType: 要生成WEB嵌入界面的类型, 可以选择的值如下:
2517
2534
 
2518
- - CREATE_SEAL: 生成创建印章的嵌入页面
2519
- - CREATE_TEMPLATE:生成创建模板的嵌入页面
2520
- - MODIFY_TEMPLATE:生成修改模板的嵌入页面
2521
- - PREVIEW_TEMPLATE:生成预览模板的嵌入页面
2522
- - PREVIEW_FLOW:生成预览合同文档的嵌入页面
2523
- - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面
2524
- - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
2525
- - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
2526
- - EXTEND_SERVICE:生成扩展服务的嵌入页面
2535
+ <ul>
2536
+ <li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
2537
+ <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
2538
+ <li>MODIFY_TEMPLATE:生成修改模板的嵌入页面</li>
2539
+ <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
2540
+ <li>PREVIEW_FLOW:生成预览合同文档的嵌入页面</li>
2541
+ <li>PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面</li>
2542
+ <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
2543
+ <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
2544
+ <li>EXTEND_SERVICE:生成扩展服务的嵌入页面</li>
2545
+ </ul>
2527
2546
  :type EmbedType: str
2528
2547
  :param _BusinessId: WEB嵌入的业务资源ID
2529
2548
 
2530
- - 当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
2531
- - 当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
2532
- - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
2549
+ <ul>
2550
+ <li>当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId</li>
2551
+ <li>当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId</li>
2552
+ <li>当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId</li>
2553
+ </ul>
2533
2554
  :type BusinessId: str
2534
2555
  :param _HiddenComponents: 是否隐藏控件,只有预览模板时生效
2535
2556
  :type HiddenComponents: bool
@@ -2614,7 +2635,7 @@ class ChannelCreateEmbedWebUrlResponse(AbstractModel):
2614
2635
 
2615
2636
  def __init__(self):
2616
2637
  r"""
2617
- :param _WebUrl: 嵌入的web链接
2638
+ :param _WebUrl: 嵌入的web链接,5分钟有效
2618
2639
  :type WebUrl: str
2619
2640
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2620
2641
  :type RequestId: str
@@ -4367,19 +4388,27 @@ class ChannelCreatePrepareFlowRequest(AbstractModel):
4367
4388
 
4368
4389
  def __init__(self):
4369
4390
  r"""
4370
- :param _ResourceId: 资源id,与ResourceType对应
4391
+ :param _ResourceId: 合同模板ID,为32位字符串。
4371
4392
  :type ResourceId: str
4372
- :param _ResourceType: 资源类型,与ResourceId对应1:模板 2: 文件
4393
+ :param _ResourceType: 资源类型,此接口固定为**1**表示为用模板发起
4373
4394
  :type ResourceType: int
4374
- :param _FlowInfo: 合同流程基础信息
4395
+ :param _FlowInfo: 要创建的合同信息
4375
4396
  :type FlowInfo: :class:`tencentcloud.essbasic.v20210526.models.BaseFlowInfo`
4376
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4397
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4398
+
4399
+ 此接口下面信息必填。
4400
+ <ul>
4401
+ <li>渠道应用标识: Agent.AppId</li>
4402
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4403
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4404
+ </ul>
4405
+ 第三方平台子客企业和员工必须已经经过实名认证
4377
4406
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4378
- :param _FlowOption: 合同流程配置信息,用于配置发起合同时定制化
4407
+ :param _FlowOption: 合同流程配置信息,用于配置发起合同时定制化如是否允许修改,某些按钮的隐藏等逻辑
4379
4408
  :type FlowOption: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowOption`
4380
4409
  :param _FlowApproverList: 合同签署人信息
4381
4410
  :type FlowApproverList: list of CommonFlowApprover
4382
- :param _FlowId: 通过flowid快速获得之前成功通过页面发起的合同生成链接
4411
+ :param _FlowId: 用过去已经通过此接口发起的合同的ID复制个新的合同创建链接
4383
4412
  :type FlowId: str
4384
4413
  :param _NeedPreview: 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
4385
4414
  :type NeedPreview: bool
@@ -4535,9 +4564,9 @@ class ChannelCreatePrepareFlowResponse(AbstractModel):
4535
4564
 
4536
4565
  def __init__(self):
4537
4566
  r"""
4538
- :param _PrepareFlowUrl: 预发起的合同链接, 可以直接点击进入进行合同发起
4567
+ :param _PrepareFlowUrl: 发起的合同嵌入链接, 可以直接点击进入进行合同发起, 有效期为5分钟
4539
4568
  :type PrepareFlowUrl: str
4540
- :param _PreviewFlowUrl: 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果
4569
+ :param _PreviewFlowUrl: 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果, 有效期为5分钟
4541
4570
  :type PreviewFlowUrl: str
4542
4571
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4543
4572
  :type RequestId: str
@@ -5276,9 +5305,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
5276
5305
  :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5277
5306
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
5278
5307
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
5279
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
5280
-
5281
- 注: `现在仅支持电子处方场景`
5308
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
5282
5309
  :type SceneKey: str
5283
5310
  :param _Operator: 执行本接口操作的员工信息。
5284
5311
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
@@ -5291,7 +5318,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
5291
5318
  :type UrlType: str
5292
5319
  :param _NotifyType: 是否通知开通方,通知类型:
5293
5320
  <ul><li>默认不设置为不通知开通方</li>
5294
- <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
5321
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
5295
5322
  :type NotifyType: str
5296
5323
  :param _NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
5297
5324
  :type NotifyAddress: str
@@ -5514,9 +5541,7 @@ class ChannelCreateUserAutoSignSealUrlRequest(AbstractModel):
5514
5541
  :param _Agent: 渠道应用相关信息。
5515
5542
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
5516
5543
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
5517
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
5518
-
5519
- 注: `现在仅支持电子处方场景`
5544
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
5520
5545
  :type SceneKey: str
5521
5546
  :param _UserInfo: 自动签开通个人用户信息,包括名字,身份证等。
5522
5547
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -7054,9 +7079,7 @@ class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
7054
7079
  :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7055
7080
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7056
7081
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
7057
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
7058
-
7059
- 注: `现在仅支持电子处方场景`
7082
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
7060
7083
  :type SceneKey: str
7061
7084
  :param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
7062
7085
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -7212,7 +7235,7 @@ class ChannelDisableUserAutoSignRequest(AbstractModel):
7212
7235
  :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7213
7236
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7214
7237
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
7215
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
7238
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
7216
7239
  :type SceneKey: str
7217
7240
  :param _UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
7218
7241
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -8014,24 +8037,50 @@ class CommonFlowApprover(AbstractModel):
8014
8037
 
8015
8038
  def __init__(self):
8016
8039
  r"""
8017
- :param _NotChannelOrganization: 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
8040
+ :param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
8041
+ <ul>
8042
+ <li>false: 默认值,第三方平台子客企业下员工</li>
8043
+ <li>true: SaaS平台企业下的员工</li>
8044
+ </ul>
8045
+
8018
8046
  :type NotChannelOrganization: bool
8019
- :param _ApproverType: 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
8047
+ :param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
8048
+
8049
+ **0** :企业/企业员工(企业签署方或模板发起时的企业静默签)
8050
+ **1** :个人/自然人
8051
+ **3** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)
8052
+
8053
+ 注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
8054
+
8020
8055
  :type ApproverType: int
8021
- :param _OrganizationId: 企业id
8056
+ :param _OrganizationId: 电子签平台给企业生成的企业id
8022
8057
  :type OrganizationId: str
8023
8058
  :param _OrganizationOpenId: 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传
8024
8059
  :type OrganizationOpenId: str
8025
8060
  :param _OrganizationName: 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
8026
8061
  :type OrganizationName: str
8027
- :param _UserId: 用户id
8062
+ :param _UserId: 电子签平台给企业员工或者自热人生成的用户id
8028
8063
  :type UserId: str
8029
- :param _OpenId: 用户openId,第三方应用集成非静默签子客企业签署人必传
8064
+ :param _OpenId: 第三方平台子客企业员工的唯一标识
8030
8065
  :type OpenId: str
8031
- :param _ApproverName: 签署人名称,saas企业签署人,个人签署人必传
8066
+ :param _ApproverName: 签署方经办人的姓名。
8067
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
8032
8068
  :type ApproverName: str
8033
8069
  :param _ApproverMobile: 签署人手机号,saas企业签署人,个人签署人必传
8034
8070
  :type ApproverMobile: str
8071
+ :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
8072
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
8073
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
8074
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
8075
+ <li>OTHER_CARD_TYPE : 其他证件</li></ul>
8076
+
8077
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
8078
+ :type ApproverIdCardType: str
8079
+ :param _ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
8080
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
8081
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
8082
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
8083
+ :type ApproverIdCardNumber: str
8035
8084
  :param _RecipientId: 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
8036
8085
  注意:模板发起时该字段必填
8037
8086
  :type RecipientId: str
@@ -8039,15 +8088,34 @@ class CommonFlowApprover(AbstractModel):
8039
8088
  :type PreReadTime: int
8040
8089
  :param _IsFullText: 签署前置条件:阅读全文限制
8041
8090
  :type IsFullText: bool
8042
- :param _NotifyType: 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
8091
+ :param _NotifyType: 通知签署方经办人的方式, 有以下途径:
8092
+ <ul><li> **SMS** :(默认)短信</li>
8093
+ <li> **NONE** : 不通知</li></ul>
8094
+
8095
+ 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
8043
8096
  :type NotifyType: str
8044
8097
  :param _ApproverOption: 签署人配置
8045
8098
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.CommonApproverOption`
8046
- :param _SignComponents: 签署控件:文件发起使用
8099
+ :param _SignComponents: 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
8047
8100
  :type SignComponents: list of Component
8048
- :param _ApproverVerifyTypes: 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 查看合同的认证方式 Flow层级的优先于approver层级的 (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
8101
+ :param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
8102
+ <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
8103
+ <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
8104
+ </li></ul>
8105
+ 注:
8106
+ <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
8107
+ <li>此字段可传多个校验方式</li></ul>
8049
8108
  :type ApproverVerifyTypes: list of int
8050
- :param _ApproverSignTypes: 签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
8109
+ :param _ApproverSignTypes: 签署人签署合同时的认证方式
8110
+ <ul><li> **1** :人脸认证</li>
8111
+ <li> **2** :签署密码</li>
8112
+ <li> **3** :运营商三要素</li></ul>
8113
+
8114
+ 默认为1(人脸认证 ),2(签署密码)
8115
+
8116
+ 注:
8117
+ 1. 用<font color='red'>模版创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
8118
+ 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
8051
8119
  :type ApproverSignTypes: list of int
8052
8120
  """
8053
8121
  self._NotChannelOrganization = None
@@ -8059,6 +8127,8 @@ class CommonFlowApprover(AbstractModel):
8059
8127
  self._OpenId = None
8060
8128
  self._ApproverName = None
8061
8129
  self._ApproverMobile = None
8130
+ self._ApproverIdCardType = None
8131
+ self._ApproverIdCardNumber = None
8062
8132
  self._RecipientId = None
8063
8133
  self._PreReadTime = None
8064
8134
  self._IsFullText = None
@@ -8140,6 +8210,22 @@ class CommonFlowApprover(AbstractModel):
8140
8210
  def ApproverMobile(self, ApproverMobile):
8141
8211
  self._ApproverMobile = ApproverMobile
8142
8212
 
8213
+ @property
8214
+ def ApproverIdCardType(self):
8215
+ return self._ApproverIdCardType
8216
+
8217
+ @ApproverIdCardType.setter
8218
+ def ApproverIdCardType(self, ApproverIdCardType):
8219
+ self._ApproverIdCardType = ApproverIdCardType
8220
+
8221
+ @property
8222
+ def ApproverIdCardNumber(self):
8223
+ return self._ApproverIdCardNumber
8224
+
8225
+ @ApproverIdCardNumber.setter
8226
+ def ApproverIdCardNumber(self, ApproverIdCardNumber):
8227
+ self._ApproverIdCardNumber = ApproverIdCardNumber
8228
+
8143
8229
  @property
8144
8230
  def RecipientId(self):
8145
8231
  return self._RecipientId
@@ -8215,6 +8301,8 @@ class CommonFlowApprover(AbstractModel):
8215
8301
  self._OpenId = params.get("OpenId")
8216
8302
  self._ApproverName = params.get("ApproverName")
8217
8303
  self._ApproverMobile = params.get("ApproverMobile")
8304
+ self._ApproverIdCardType = params.get("ApproverIdCardType")
8305
+ self._ApproverIdCardNumber = params.get("ApproverIdCardNumber")
8218
8306
  self._RecipientId = params.get("RecipientId")
8219
8307
  self._PreReadTime = params.get("PreReadTime")
8220
8308
  self._IsFullText = params.get("IsFullText")
@@ -8969,9 +9057,9 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
8969
9057
 
8970
9058
  此接口下面信息必填。
8971
9059
  <ul>
8972
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
9060
+ <li>渠道应用标识: Agent.AppId</li>
8973
9061
  <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
8974
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
9062
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOrganizationOpenId</li>
8975
9063
  </ul>
8976
9064
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
8977
9065
  :param _ChangeType: 企业信息变更类型,可选类型如下:
@@ -9350,18 +9438,33 @@ class CreateFlowOption(AbstractModel):
9350
9438
 
9351
9439
  def __init__(self):
9352
9440
  r"""
9353
- :param _CanEditFlow: 是否允许修改合同信息,true-是,false-否
9441
+ :param _CanEditFlow: 是否允许修改合同信息,
9442
+ **true**:可以
9443
+ **false**:(默认)不可以
9354
9444
  :type CanEditFlow: bool
9355
- :param _HideShowFlowName: 是否允许发起合同弹窗隐藏合同名称,true-允许,false-不允许
9445
+ :param _HideShowFlowName: 是否允许发起合同弹窗隐藏合同名称
9446
+ **true**:允许
9447
+ **false**:(默认)不允许
9356
9448
  :type HideShowFlowName: bool
9357
- :param _HideShowFlowType: 是否允许发起合同弹窗隐藏合同类型,true-允许,false-不允许
9449
+ :param _HideShowFlowType: 是否允许发起合同弹窗隐藏合同类型,
9450
+ **true**:允许
9451
+ **false**:(默认)不允许
9358
9452
  :type HideShowFlowType: bool
9359
- :param _HideShowDeadline: 是否允许发起合同弹窗隐藏合同到期时间,true-允许,false-不允许
9453
+ :param _HideShowDeadline: 是否允许发起合同弹窗隐藏合同到期时间
9454
+ **true**:允许
9455
+ **false**:(默认)不允许
9360
9456
  :type HideShowDeadline: bool
9361
- :param _CanSkipAddApprover: 是否允许发起合同步骤跳过指定签署方步骤,true-允许,false-不允许
9457
+ :param _CanSkipAddApprover: 是否允许发起合同步骤跳过指定签署方步骤
9458
+ **true**:允许
9459
+ **false**:(默认)不允许
9362
9460
  :type CanSkipAddApprover: bool
9363
- :param _CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500
9461
+ :param _CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,长度不能超过500,只能由中文、字母、数字和标点组成。
9364
9462
  :type CustomCreateFlowDescription: str
9463
+ :param _ForbidEditFillComponent: 禁止编辑填写控件
9464
+
9465
+ **true**:禁止编辑填写控件
9466
+ **false**:(默认)允许编辑填写控件
9467
+ :type ForbidEditFillComponent: bool
9365
9468
  """
9366
9469
  self._CanEditFlow = None
9367
9470
  self._HideShowFlowName = None
@@ -9369,6 +9472,7 @@ class CreateFlowOption(AbstractModel):
9369
9472
  self._HideShowDeadline = None
9370
9473
  self._CanSkipAddApprover = None
9371
9474
  self._CustomCreateFlowDescription = None
9475
+ self._ForbidEditFillComponent = None
9372
9476
 
9373
9477
  @property
9374
9478
  def CanEditFlow(self):
@@ -9418,6 +9522,14 @@ class CreateFlowOption(AbstractModel):
9418
9522
  def CustomCreateFlowDescription(self, CustomCreateFlowDescription):
9419
9523
  self._CustomCreateFlowDescription = CustomCreateFlowDescription
9420
9524
 
9525
+ @property
9526
+ def ForbidEditFillComponent(self):
9527
+ return self._ForbidEditFillComponent
9528
+
9529
+ @ForbidEditFillComponent.setter
9530
+ def ForbidEditFillComponent(self, ForbidEditFillComponent):
9531
+ self._ForbidEditFillComponent = ForbidEditFillComponent
9532
+
9421
9533
 
9422
9534
  def _deserialize(self, params):
9423
9535
  self._CanEditFlow = params.get("CanEditFlow")
@@ -9426,6 +9538,7 @@ class CreateFlowOption(AbstractModel):
9426
9538
  self._HideShowDeadline = params.get("HideShowDeadline")
9427
9539
  self._CanSkipAddApprover = params.get("CanSkipAddApprover")
9428
9540
  self._CustomCreateFlowDescription = params.get("CustomCreateFlowDescription")
9541
+ self._ForbidEditFillComponent = params.get("ForbidEditFillComponent")
9429
9542
  memeber_set = set(params.keys())
9430
9543
  for name, value in vars(self).items():
9431
9544
  property_name = name[1:]
@@ -9934,7 +10047,7 @@ class CreateSignUrlsRequest(AbstractModel):
9934
10047
  注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
9935
10048
  :type Mobile: str
9936
10049
  :param _IdCardType: 证件类型,支持以下类型
9937
- <ul><li>ID_CARD : 居民身份证(默认值)</li>
10050
+ <ul><li>ID_CARD : 居民身份证</li>
9938
10051
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
9939
10052
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
9940
10053
  :type IdCardType: str
@@ -13194,6 +13307,7 @@ class FlowInfo(AbstractModel):
13194
13307
  示例值:1604912664
13195
13308
  :type Deadline: int
13196
13309
  :param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
13310
+ 如果使用模板发起接口,此参数为必填。
13197
13311
 
13198
13312
  可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
13199
13313
  :type TemplateId: str
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1037
3
+ Version: 3.0.1039
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
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common==3.0.1039
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common==3.0.1037