tencentcloud-sdk-python-essbasic 3.0.1024__py2.py3-none-any.whl → 3.0.1044__py2.py3-none-any.whl

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.
@@ -236,11 +236,13 @@ class ApproverOption(AbstractModel):
236
236
  r"""
237
237
  :param _NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
238
238
  :type NoRefuse: bool
239
+ :param _NoTransfer: 是否可以转发 默认false-可以转发 true-不可以转发
240
+ :type NoTransfer: bool
239
241
  :param _HideOneKeySign: 是否隐藏一键签署 默认false-不隐藏true-隐藏
240
242
  :type HideOneKeySign: bool
241
243
  :param _FillType: 签署人信息补充类型,默认无需补充。
242
244
 
243
- <ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)</li>
245
+ <ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)注:`企业自动签不支持动态补充`</li>
244
246
  </ul>
245
247
  :type FillType: int
246
248
  :param _FlowReadLimit: 签署人阅读合同限制参数
@@ -254,6 +256,7 @@ class ApproverOption(AbstractModel):
254
256
  :type FlowReadLimit: str
255
257
  """
256
258
  self._NoRefuse = None
259
+ self._NoTransfer = None
257
260
  self._HideOneKeySign = None
258
261
  self._FillType = None
259
262
  self._FlowReadLimit = None
@@ -266,6 +269,14 @@ class ApproverOption(AbstractModel):
266
269
  def NoRefuse(self, NoRefuse):
267
270
  self._NoRefuse = NoRefuse
268
271
 
272
+ @property
273
+ def NoTransfer(self):
274
+ return self._NoTransfer
275
+
276
+ @NoTransfer.setter
277
+ def NoTransfer(self, NoTransfer):
278
+ self._NoTransfer = NoTransfer
279
+
269
280
  @property
270
281
  def HideOneKeySign(self):
271
282
  return self._HideOneKeySign
@@ -293,6 +304,7 @@ class ApproverOption(AbstractModel):
293
304
 
294
305
  def _deserialize(self, params):
295
306
  self._NoRefuse = params.get("NoRefuse")
307
+ self._NoTransfer = params.get("NoTransfer")
296
308
  self._HideOneKeySign = params.get("HideOneKeySign")
297
309
  self._FillType = params.get("FillType")
298
310
  self._FlowReadLimit = params.get("FlowReadLimit")
@@ -489,7 +501,7 @@ class AutoSignConfig(AbstractModel):
489
501
  :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
490
502
 
491
503
  <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
492
- </ul>
504
+ <li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
493
505
  :type LicenseType: int
494
506
  """
495
507
  self._UserInfo = None
@@ -584,35 +596,43 @@ class BaseFlowInfo(AbstractModel):
584
596
 
585
597
  def __init__(self):
586
598
  r"""
587
- :param _FlowName: 合同流程名称
599
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
588
600
  :type FlowName: str
589
- :param _FlowType: 合同流程类型
590
- <br/>客户自定义,用于合同分类展示
601
+ :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
591
602
  :type FlowType: str
592
- :param _FlowDescription: 合同流程描述信息
603
+ :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
593
604
  :type FlowDescription: str
594
- :param _Deadline: 合同流程截止时间,unix时间戳,单位秒
605
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
595
606
  :type Deadline: int
596
- :param _Unordered: 是否顺序签署(true:无序签,false:顺序签)
597
- <br/>默认false,有序签署合同
607
+ :param _Unordered: 合同流程的签署顺序类型:
608
+ **false**:(默认)有序签署, 本合同多个参与人需要依次签署
609
+ **true**:无序签署, 本合同多个参与人没有先后签署限制
598
610
  :type Unordered: bool
599
611
  :param _IntelligentStatus: 是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
600
612
  :type IntelligentStatus: str
601
- :param _FormFields: 填写控件内容
613
+ :param _FormFields: 填写控件内容, 填写的控制的ID-填写的内容对列表
602
614
  :type FormFields: list of FormField
603
- :param _NeedSignReview: 本企业(发起方企业)是否需要签署审批
604
- <br/>true:开启发起方签署审批
605
- <br/>false:不开启发起方签署审批
606
- <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
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
607
622
  :type NeedSignReview: bool
608
- :param _UserData: 用户流程自定义数据参数
623
+ :param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
624
+
625
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
609
626
  :type UserData: str
610
- :param _CcInfos: 抄送人信息
627
+ :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
628
+
629
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
611
630
  :type CcInfos: list of CcInfo
612
- :param _NeedCreateReview: 是否需要开启发起方发起前审核
613
- <br/>true:开启发起方发起前审核
614
- <br/>false:不开启发起方发起前审核
615
- <br/>当指定NeedCreateReview=true,则提交审核后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
631
+ :param _NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
632
+
633
+ 若设置为true,发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
634
+
635
+
616
636
  :type NeedCreateReview: bool
617
637
  :param _Components: 填写控件:文件发起使用
618
638
  :type Components: list of Component
@@ -1064,7 +1084,7 @@ class ChannelBatchCancelFlowsRequest(AbstractModel):
1064
1084
 
1065
1085
  注: `CancelMessage为撤销当前合同的理由`
1066
1086
 
1067
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
1087
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)
1068
1088
 
1069
1089
 
1070
1090
  :type CancelMessageFormat: int
@@ -1606,7 +1626,8 @@ class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
1606
1626
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1607
1627
  :param _Operator: 操作人信息
1608
1628
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
1609
- :param _SceneKey: 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
1629
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
1630
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
1610
1631
  :type SceneKey: str
1611
1632
  :param _UserInfo: 指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
1612
1633
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -1860,9 +1881,10 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
1860
1881
  :type SignatureTypes: list of int
1861
1882
  :param _ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值:
1862
1883
  <ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
1884
+ <li>**2**:密码认证(默认),需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署</li>
1863
1885
  <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
1864
1886
  注:
1865
- <ul><li>默认情况下,认证校验方式为人脸认证</li>
1887
+ <ul><li>默认情况下,认证校验方式为人脸和密码认证</li>
1866
1888
  <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
1867
1889
  :type ApproverSignTypes: list of int
1868
1890
  """
@@ -2351,6 +2373,7 @@ class ChannelCreateConvertTaskApiRequest(AbstractModel):
2351
2373
  <li>jpeg</li>
2352
2374
  <li>png</li>
2353
2375
  <li>bmp</li>
2376
+ <li>html</li>
2354
2377
  <li>txt</li></ul>
2355
2378
  :type ResourceType: str
2356
2379
  :param _ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
@@ -2497,36 +2520,61 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2497
2520
 
2498
2521
  def __init__(self):
2499
2522
  r"""
2500
- :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
+ 第三方平台子客企业和员工必须已经经过实名认证
2501
2532
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2502
2533
  :param _EmbedType: 要生成WEB嵌入界面的类型, 可以选择的值如下:
2503
2534
 
2504
- - CREATE_SEAL: 生成创建印章的嵌入页面
2505
- - CREATE_TEMPLATE:生成创建模板的嵌入页面
2506
- - MODIFY_TEMPLATE:生成修改模板的嵌入页面
2507
- - PREVIEW_TEMPLATE:生成预览模板的嵌入页面
2508
- - PREVIEW_FLOW:生成预览合同文档的嵌入页面
2509
- - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面
2510
- - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
2511
- - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
2512
- - 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>
2513
2546
  :type EmbedType: str
2514
2547
  :param _BusinessId: WEB嵌入的业务资源ID
2515
2548
 
2516
- - 当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
2517
- - 当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
2518
- - 当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>
2519
2554
  :type BusinessId: str
2520
2555
  :param _HiddenComponents: 是否隐藏控件,只有预览模板时生效
2521
2556
  :type HiddenComponents: bool
2522
2557
  :param _Operator: 渠道操作者信息
2523
2558
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
2559
+ :param _UserData: 用户自定义参数
2560
+ <ul>
2561
+ <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
2562
+ <li>指定后,创建,编辑,删除模版时,回调都会携带该userData</li>
2563
+ <li>支持的格式:json字符串的BASE64编码字符串</li>
2564
+ <li>示例:<ul>
2565
+ <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li>
2566
+ <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li>
2567
+ </ul>
2568
+ </li>
2569
+ </ul>
2570
+ :type UserData: str
2524
2571
  """
2525
2572
  self._Agent = None
2526
2573
  self._EmbedType = None
2527
2574
  self._BusinessId = None
2528
2575
  self._HiddenComponents = None
2529
2576
  self._Operator = None
2577
+ self._UserData = None
2530
2578
 
2531
2579
  @property
2532
2580
  def Agent(self):
@@ -2572,6 +2620,14 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2572
2620
 
2573
2621
  self._Operator = Operator
2574
2622
 
2623
+ @property
2624
+ def UserData(self):
2625
+ return self._UserData
2626
+
2627
+ @UserData.setter
2628
+ def UserData(self, UserData):
2629
+ self._UserData = UserData
2630
+
2575
2631
 
2576
2632
  def _deserialize(self, params):
2577
2633
  if params.get("Agent") is not None:
@@ -2583,6 +2639,7 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2583
2639
  if params.get("Operator") is not None:
2584
2640
  self._Operator = UserInfo()
2585
2641
  self._Operator._deserialize(params.get("Operator"))
2642
+ self._UserData = params.get("UserData")
2586
2643
  memeber_set = set(params.keys())
2587
2644
  for name, value in vars(self).items():
2588
2645
  property_name = name[1:]
@@ -2600,7 +2657,7 @@ class ChannelCreateEmbedWebUrlResponse(AbstractModel):
2600
2657
 
2601
2658
  def __init__(self):
2602
2659
  r"""
2603
- :param _WebUrl: 嵌入的web链接
2660
+ :param _WebUrl: 嵌入的web链接,5分钟有效
2604
2661
  :type WebUrl: str
2605
2662
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2606
2663
  :type RequestId: str
@@ -2655,18 +2712,18 @@ class ChannelCreateFlowApproversRequest(AbstractModel):
2655
2712
 
2656
2713
  - 如果不指定,则使用姓名和手机号进行补充。
2657
2714
  :type Approvers: list of FillApproverInfo
2658
- :param _Operator: 操作人信息
2659
- :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
2660
2715
  :param _FillApproverType: 签署人信息补充方式
2661
2716
 
2662
- <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
2717
+ <ul><li>**1**: 表示往未指定签署人的节点,添加一个明确的签署人,支持企业或个人签署方。</li></ul>
2663
2718
  :type FillApproverType: int
2719
+ :param _Operator: 操作人信息
2720
+ :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
2664
2721
  """
2665
2722
  self._Agent = None
2666
2723
  self._FlowId = None
2667
2724
  self._Approvers = None
2668
- self._Operator = None
2669
2725
  self._FillApproverType = None
2726
+ self._Operator = None
2670
2727
 
2671
2728
  @property
2672
2729
  def Agent(self):
@@ -2692,14 +2749,6 @@ class ChannelCreateFlowApproversRequest(AbstractModel):
2692
2749
  def Approvers(self, Approvers):
2693
2750
  self._Approvers = Approvers
2694
2751
 
2695
- @property
2696
- def Operator(self):
2697
- return self._Operator
2698
-
2699
- @Operator.setter
2700
- def Operator(self, Operator):
2701
- self._Operator = Operator
2702
-
2703
2752
  @property
2704
2753
  def FillApproverType(self):
2705
2754
  return self._FillApproverType
@@ -2708,6 +2757,14 @@ class ChannelCreateFlowApproversRequest(AbstractModel):
2708
2757
  def FillApproverType(self, FillApproverType):
2709
2758
  self._FillApproverType = FillApproverType
2710
2759
 
2760
+ @property
2761
+ def Operator(self):
2762
+ return self._Operator
2763
+
2764
+ @Operator.setter
2765
+ def Operator(self, Operator):
2766
+ self._Operator = Operator
2767
+
2711
2768
 
2712
2769
  def _deserialize(self, params):
2713
2770
  if params.get("Agent") is not None:
@@ -2720,10 +2777,10 @@ class ChannelCreateFlowApproversRequest(AbstractModel):
2720
2777
  obj = FillApproverInfo()
2721
2778
  obj._deserialize(item)
2722
2779
  self._Approvers.append(obj)
2780
+ self._FillApproverType = params.get("FillApproverType")
2723
2781
  if params.get("Operator") is not None:
2724
2782
  self._Operator = UserInfo()
2725
2783
  self._Operator._deserialize(params.get("Operator"))
2726
- self._FillApproverType = params.get("FillApproverType")
2727
2784
  memeber_set = set(params.keys())
2728
2785
  for name, value in vars(self).items():
2729
2786
  property_name = name[1:]
@@ -4353,19 +4410,34 @@ class ChannelCreatePrepareFlowRequest(AbstractModel):
4353
4410
 
4354
4411
  def __init__(self):
4355
4412
  r"""
4356
- :param _ResourceId: 资源id,与ResourceType对应
4413
+ :param _ResourceId: 资源id,与ResourceType相对应,取值范围:
4414
+ <ul>
4415
+ <li>文件Id(通过UploadFiles获取文件资源Id)</li>
4416
+ <li>模板Id</li>
4417
+ </ul>
4357
4418
  :type ResourceId: str
4358
- :param _ResourceType: 资源类型,与ResourceId对应1:模板 2: 文件
4419
+ :param _ResourceType: 资源类型,取值有:
4420
+ <ul><li> **1**:模板</li>
4421
+ <li> **2**:文件(默认值)</li></ul>
4359
4422
  :type ResourceType: int
4360
- :param _FlowInfo: 合同流程基础信息
4423
+ :param _FlowInfo: 要创建的合同信息
4361
4424
  :type FlowInfo: :class:`tencentcloud.essbasic.v20210526.models.BaseFlowInfo`
4362
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4425
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4426
+
4427
+ 此接口下面信息必填。
4428
+ <ul>
4429
+ <li>渠道应用标识: Agent.AppId</li>
4430
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4431
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4432
+ </ul>
4433
+ 第三方平台子客企业和员工必须已经经过实名认证
4363
4434
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4364
- :param _FlowOption: 合同流程配置信息,用于配置发起合同时定制化
4435
+ :param _FlowOption: 合同流程配置信息,用于配置发起合同时定制化如是否允许修改,某些按钮的隐藏等逻辑
4365
4436
  :type FlowOption: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowOption`
4366
4437
  :param _FlowApproverList: 合同签署人信息
4367
4438
  :type FlowApproverList: list of CommonFlowApprover
4368
- :param _FlowId: 通过flowid快速获得之前成功通过页面发起的合同生成链接
4439
+ :param _FlowId: 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
4440
+ 注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
4369
4441
  :type FlowId: str
4370
4442
  :param _NeedPreview: 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
4371
4443
  :type NeedPreview: bool
@@ -4521,9 +4593,9 @@ class ChannelCreatePrepareFlowResponse(AbstractModel):
4521
4593
 
4522
4594
  def __init__(self):
4523
4595
  r"""
4524
- :param _PrepareFlowUrl: 预发起的合同链接, 可以直接点击进入进行合同发起
4596
+ :param _PrepareFlowUrl: 发起的合同嵌入链接, 可以直接点击进入进行合同发起, 有效期为5分钟
4525
4597
  :type PrepareFlowUrl: str
4526
- :param _PreviewFlowUrl: 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果
4598
+ :param _PreviewFlowUrl: 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果, 有效期为5分钟
4527
4599
  :type PreviewFlowUrl: str
4528
4600
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4529
4601
  :type RequestId: str
@@ -5262,9 +5334,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
5262
5334
  :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5263
5335
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
5264
5336
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
5265
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
5266
-
5267
- 注: `现在仅支持电子处方场景`
5337
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
5268
5338
  :type SceneKey: str
5269
5339
  :param _Operator: 执行本接口操作的员工信息。
5270
5340
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
@@ -5277,7 +5347,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
5277
5347
  :type UrlType: str
5278
5348
  :param _NotifyType: 是否通知开通方,通知类型:
5279
5349
  <ul><li>默认不设置为不通知开通方</li>
5280
- <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
5350
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
5281
5351
  :type NotifyType: str
5282
5352
  :param _NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
5283
5353
  :type NotifyAddress: str
@@ -5500,9 +5570,7 @@ class ChannelCreateUserAutoSignSealUrlRequest(AbstractModel):
5500
5570
  :param _Agent: 渠道应用相关信息。
5501
5571
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
5502
5572
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
5503
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
5504
-
5505
- 注: `现在仅支持电子处方场景`
5573
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
5506
5574
  :type SceneKey: str
5507
5575
  :param _UserInfo: 自动签开通个人用户信息,包括名字,身份证等。
5508
5576
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -6097,12 +6165,13 @@ class ChannelDeleteSealPoliciesRequest(AbstractModel):
6097
6165
 
6098
6166
  def __init__(self):
6099
6167
  r"""
6100
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
6168
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6101
6169
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6102
- :param _SealId: 指定印章ID
6170
+ :param _SealId: 操作的印章ID
6103
6171
  :type SealId: str
6104
- :param _UserIds: 指定用户ID数组,电子签系统用户ID
6105
- 可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权取消。
6172
+ :param _UserIds: 需要删除授权的用户ID数组,可以传入电子签系统用户ID或OpenId。
6173
+ 注:
6174
+ 1. `填写OpenId时,系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`
6106
6175
  :type UserIds: list of str
6107
6176
  :param _Organization: 组织机构信息,不用传
6108
6177
  :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
@@ -6678,23 +6747,30 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6678
6747
 
6679
6748
  def __init__(self):
6680
6749
  r"""
6681
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
6750
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6682
6751
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6683
6752
  :param _Limit: 返回最大数量,最大为100
6684
6753
  :type Limit: int
6685
- :param _Offset: 偏移量,默认为0,最大为20000
6754
+ :param _Offset: 分页查询偏移量,默认为0,最大为20000
6686
6755
  :type Offset: int
6687
- :param _InfoType: 查询信息类型,为1时返回授权用户,为其他值时不返回
6756
+ :param _InfoType: 查询信息类型
6757
+ 支持的值如下:
6758
+ <ul><li>0-默认,不返回授权用户信息</li>
6759
+ <li>1-返回授权用户信息</li>
6760
+ </ul>
6688
6761
  :type InfoType: int
6689
6762
  :param _SealId: 印章id(没有输入返回所有)
6763
+
6764
+ 注: `没有输入返回所有记录,最大返回100条。`
6690
6765
  :type SealId: str
6691
- :param _SealTypes: 印章类型列表(都是组织机构印章)。
6692
- 为空时查询所有类型的印章。
6693
- 目前支持以下类型:
6694
- OFFICIAL:企业公章;
6695
- CONTRACT:合同专用章;
6696
- ORGANIZATION_SEAL:企业印章(图片上传创建);
6697
- LEGAL_PERSON_SEAL:法定代表人章
6766
+ :param _SealTypes: 印章类型列表,目前支持传入以下类型:
6767
+ <ul><li>OFFICIAL-企业公章</li>
6768
+ <li>CONTRACT-合同专用章</li>
6769
+ <li>ORGANIZATION_SEAL-企业印章(图片上传创建)</li>
6770
+ <li>LEGAL_PERSON_SEAL-法定代表人章</li>
6771
+ </ul>
6772
+
6773
+ 注: `为空时查询所有类型的印章。`
6698
6774
  :type SealTypes: list of str
6699
6775
  """
6700
6776
  self._Agent = None
@@ -6843,14 +6919,26 @@ class ChannelDescribeRolesRequest(AbstractModel):
6843
6919
  </ul>
6844
6920
  第三方平台子客企业和员工必须已经经过实名认证
6845
6921
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6846
- :param _Limit: 指定每页多少条数据,单页最大200
6922
+ :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
6923
+
6924
+ 注: `因为历史原因, 此字段为字符串类型`
6847
6925
  :type Limit: str
6848
6926
  :param _Filters: 查询的关键字段:
6849
- Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
6850
- Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
6851
- Key:"IsReturnPermissionGroup",Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
6927
+ Key:"**RoleType**",Values:["**1**"]查询系统角色,
6928
+ Key:"**RoleType**",Values:["**2**"]查询自定义角色
6929
+ Key:"**RoleStatus**",Values:["**1**"]查询启用角色
6930
+ Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
6931
+ Key:"**IsReturnPermissionGroup**",Values:["**0**"]表示接口不返回角色对应的权限树字段
6932
+ Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对应的权限树字段
6933
+
6934
+ 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
6935
+
6852
6936
  :type Filters: list of Filter
6853
- :param _Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
6937
+ :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
6938
+
6939
+ 注:
6940
+ 1.`offset从0开始,即第一页为0。`
6941
+ 2.`默认从第一页返回。`
6854
6942
  :type Offset: int
6855
6943
  :param _Operator: 操作人信息
6856
6944
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -6938,13 +7026,13 @@ class ChannelDescribeRolesResponse(AbstractModel):
6938
7026
 
6939
7027
  def __init__(self):
6940
7028
  r"""
6941
- :param _Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
7029
+ :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
6942
7030
  :type Offset: int
6943
- :param _Limit: 指定每页多少条数据,单页最大200
7031
+ :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
6944
7032
  :type Limit: int
6945
7033
  :param _TotalCount: 查询角色的总数量
6946
7034
  :type TotalCount: int
6947
- :param _ChannelRoles: 角色信息
7035
+ :param _ChannelRoles: 查询的角色信息列表
6948
7036
  注意:此字段可能返回 null,表示取不到有效值。
6949
7037
  :type ChannelRoles: list of ChannelRole
6950
7038
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -7020,9 +7108,7 @@ class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
7020
7108
  :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7021
7109
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7022
7110
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
7023
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
7024
-
7025
- 注: `现在仅支持电子处方场景`
7111
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
7026
7112
  :type SceneKey: str
7027
7113
  :param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
7028
7114
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -7178,7 +7264,7 @@ class ChannelDisableUserAutoSignRequest(AbstractModel):
7178
7264
  :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7179
7265
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7180
7266
  :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
7181
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
7267
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
7182
7268
  :type SceneKey: str
7183
7269
  :param _UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
7184
7270
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -7590,21 +7676,23 @@ class ChannelModifyRoleResponse(AbstractModel):
7590
7676
 
7591
7677
 
7592
7678
  class ChannelRole(AbstractModel):
7593
- """渠道角色信息
7679
+ """角色信息
7594
7680
 
7595
7681
  """
7596
7682
 
7597
7683
  def __init__(self):
7598
7684
  r"""
7599
- :param _RoleId: 角色id
7685
+ :param _RoleId: 角色ID,为32位字符串
7600
7686
  注意:此字段可能返回 null,表示取不到有效值。
7601
7687
  :type RoleId: str
7602
- :param _RoleName: 角色名
7688
+ :param _RoleName: 角色的名称
7603
7689
  注意:此字段可能返回 null,表示取不到有效值。
7604
7690
  :type RoleName: str
7605
- :param _RoleStatus: 角色状态:1-启用;2-禁用
7691
+ :param _RoleStatus: 此角色状态
7692
+ 1: 已经启用
7693
+ 2: 已经禁用
7606
7694
  :type RoleStatus: int
7607
- :param _PermissionGroups: 权限树
7695
+ :param _PermissionGroups: 此角色对应的权限列表
7608
7696
  注意:此字段可能返回 null,表示取不到有效值。
7609
7697
  :type PermissionGroups: list of PermissionGroup
7610
7698
  """
@@ -7673,9 +7761,10 @@ class ChannelUpdateSealStatusRequest(AbstractModel):
7673
7761
 
7674
7762
  def __init__(self):
7675
7763
  r"""
7676
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
7764
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7677
7765
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7678
- :param _Status: 操作的印章状态,DISABLE-停用印章
7766
+ :param _Status: 印章状态,目前支持传入以下类型:
7767
+ <ul><li>DISABLE-停用印章</li></ul>
7679
7768
  :type Status: str
7680
7769
  :param _SealId: 印章ID
7681
7770
  :type SealId: str
@@ -7977,24 +8066,50 @@ class CommonFlowApprover(AbstractModel):
7977
8066
 
7978
8067
  def __init__(self):
7979
8068
  r"""
7980
- :param _NotChannelOrganization: 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
8069
+ :param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
8070
+ <ul>
8071
+ <li>false: 默认值,第三方平台子客企业下员工</li>
8072
+ <li>true: SaaS平台企业下的员工</li>
8073
+ </ul>
8074
+
7981
8075
  :type NotChannelOrganization: bool
7982
- :param _ApproverType: 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
8076
+ :param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
8077
+
8078
+ **0** :企业/企业员工(企业签署方或模板发起时的企业静默签)
8079
+ **1** :个人/自然人
8080
+ **3** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)
8081
+
8082
+ 注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
8083
+
7983
8084
  :type ApproverType: int
7984
- :param _OrganizationId: 企业id
8085
+ :param _OrganizationId: 电子签平台给企业生成的企业id
7985
8086
  :type OrganizationId: str
7986
8087
  :param _OrganizationOpenId: 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传
7987
8088
  :type OrganizationOpenId: str
7988
8089
  :param _OrganizationName: 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
7989
8090
  :type OrganizationName: str
7990
- :param _UserId: 用户id
8091
+ :param _UserId: 电子签平台给企业员工或者自热人生成的用户id
7991
8092
  :type UserId: str
7992
- :param _OpenId: 用户openId,第三方应用集成非静默签子客企业签署人必传
8093
+ :param _OpenId: 第三方平台子客企业员工的唯一标识
7993
8094
  :type OpenId: str
7994
- :param _ApproverName: 签署人名称,saas企业签署人,个人签署人必传
8095
+ :param _ApproverName: 签署方经办人的姓名。
8096
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
7995
8097
  :type ApproverName: str
7996
8098
  :param _ApproverMobile: 签署人手机号,saas企业签署人,个人签署人必传
7997
8099
  :type ApproverMobile: str
8100
+ :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
8101
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
8102
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
8103
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
8104
+ <li>OTHER_CARD_TYPE : 其他证件</li></ul>
8105
+
8106
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
8107
+ :type ApproverIdCardType: str
8108
+ :param _ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
8109
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
8110
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
8111
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
8112
+ :type ApproverIdCardNumber: str
7998
8113
  :param _RecipientId: 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
7999
8114
  注意:模板发起时该字段必填
8000
8115
  :type RecipientId: str
@@ -8002,15 +8117,34 @@ class CommonFlowApprover(AbstractModel):
8002
8117
  :type PreReadTime: int
8003
8118
  :param _IsFullText: 签署前置条件:阅读全文限制
8004
8119
  :type IsFullText: bool
8005
- :param _NotifyType: 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
8120
+ :param _NotifyType: 通知签署方经办人的方式, 有以下途径:
8121
+ <ul><li> **SMS** :(默认)短信</li>
8122
+ <li> **NONE** : 不通知</li></ul>
8123
+
8124
+ 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
8006
8125
  :type NotifyType: str
8007
8126
  :param _ApproverOption: 签署人配置
8008
8127
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.CommonApproverOption`
8009
- :param _SignComponents: 签署控件:文件发起使用
8128
+ :param _SignComponents: 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
8010
8129
  :type SignComponents: list of Component
8011
- :param _ApproverVerifyTypes: 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 查看合同的认证方式 Flow层级的优先于approver层级的 (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
8130
+ :param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
8131
+ <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
8132
+ <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
8133
+ </li></ul>
8134
+ 注:
8135
+ <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
8136
+ <li>此字段可传多个校验方式</li></ul>
8012
8137
  :type ApproverVerifyTypes: list of int
8013
- :param _ApproverSignTypes: 签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
8138
+ :param _ApproverSignTypes: 签署人签署合同时的认证方式
8139
+ <ul><li> **1** :人脸认证</li>
8140
+ <li> **2** :签署密码</li>
8141
+ <li> **3** :运营商三要素</li></ul>
8142
+
8143
+ 默认为1(人脸认证 ),2(签署密码)
8144
+
8145
+ 注:
8146
+ 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
8147
+ 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
8014
8148
  :type ApproverSignTypes: list of int
8015
8149
  """
8016
8150
  self._NotChannelOrganization = None
@@ -8022,6 +8156,8 @@ class CommonFlowApprover(AbstractModel):
8022
8156
  self._OpenId = None
8023
8157
  self._ApproverName = None
8024
8158
  self._ApproverMobile = None
8159
+ self._ApproverIdCardType = None
8160
+ self._ApproverIdCardNumber = None
8025
8161
  self._RecipientId = None
8026
8162
  self._PreReadTime = None
8027
8163
  self._IsFullText = None
@@ -8103,6 +8239,22 @@ class CommonFlowApprover(AbstractModel):
8103
8239
  def ApproverMobile(self, ApproverMobile):
8104
8240
  self._ApproverMobile = ApproverMobile
8105
8241
 
8242
+ @property
8243
+ def ApproverIdCardType(self):
8244
+ return self._ApproverIdCardType
8245
+
8246
+ @ApproverIdCardType.setter
8247
+ def ApproverIdCardType(self, ApproverIdCardType):
8248
+ self._ApproverIdCardType = ApproverIdCardType
8249
+
8250
+ @property
8251
+ def ApproverIdCardNumber(self):
8252
+ return self._ApproverIdCardNumber
8253
+
8254
+ @ApproverIdCardNumber.setter
8255
+ def ApproverIdCardNumber(self, ApproverIdCardNumber):
8256
+ self._ApproverIdCardNumber = ApproverIdCardNumber
8257
+
8106
8258
  @property
8107
8259
  def RecipientId(self):
8108
8260
  return self._RecipientId
@@ -8178,6 +8330,8 @@ class CommonFlowApprover(AbstractModel):
8178
8330
  self._OpenId = params.get("OpenId")
8179
8331
  self._ApproverName = params.get("ApproverName")
8180
8332
  self._ApproverMobile = params.get("ApproverMobile")
8333
+ self._ApproverIdCardType = params.get("ApproverIdCardType")
8334
+ self._ApproverIdCardNumber = params.get("ApproverIdCardNumber")
8181
8335
  self._RecipientId = params.get("RecipientId")
8182
8336
  self._PreReadTime = params.get("PreReadTime")
8183
8337
  self._IsFullText = params.get("IsFullText")
@@ -8932,9 +9086,9 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
8932
9086
 
8933
9087
  此接口下面信息必填。
8934
9088
  <ul>
8935
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
9089
+ <li>渠道应用标识: Agent.AppId</li>
8936
9090
  <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
8937
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
9091
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOrganizationOpenId</li>
8938
9092
  </ul>
8939
9093
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
8940
9094
  :param _ChangeType: 企业信息变更类型,可选类型如下:
@@ -9313,18 +9467,38 @@ class CreateFlowOption(AbstractModel):
9313
9467
 
9314
9468
  def __init__(self):
9315
9469
  r"""
9316
- :param _CanEditFlow: 是否允许修改合同信息,true-是,false-否
9470
+ :param _CanEditFlow: 是否允许修改合同信息,
9471
+ **true**:可以
9472
+ **false**:(默认)不可以
9317
9473
  :type CanEditFlow: bool
9318
- :param _HideShowFlowName: 是否允许发起合同弹窗隐藏合同名称,true-允许,false-不允许
9474
+ :param _HideShowFlowName: 是否允许发起合同弹窗隐藏合同名称
9475
+ **true**:允许
9476
+ **false**:(默认)不允许
9319
9477
  :type HideShowFlowName: bool
9320
- :param _HideShowFlowType: 是否允许发起合同弹窗隐藏合同类型,true-允许,false-不允许
9478
+ :param _HideShowFlowType: 是否允许发起合同弹窗隐藏合同类型,
9479
+ **true**:允许
9480
+ **false**:(默认)不允许
9321
9481
  :type HideShowFlowType: bool
9322
- :param _HideShowDeadline: 是否允许发起合同弹窗隐藏合同到期时间,true-允许,false-不允许
9482
+ :param _HideShowDeadline: 是否允许发起合同弹窗隐藏合同到期时间
9483
+ **true**:允许
9484
+ **false**:(默认)不允许
9323
9485
  :type HideShowDeadline: bool
9324
- :param _CanSkipAddApprover: 是否允许发起合同步骤跳过指定签署方步骤,true-允许,false-不允许
9486
+ :param _CanSkipAddApprover: 是否允许发起合同步骤跳过指定签署方步骤
9487
+ **true**:允许
9488
+ **false**:(默认)不允许
9325
9489
  :type CanSkipAddApprover: bool
9326
- :param _CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500
9490
+ :param _CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,长度不能超过500,只能由中文、字母、数字和标点组成。
9327
9491
  :type CustomCreateFlowDescription: str
9492
+ :param _ForbidEditFillComponent: 禁止编辑填写控件
9493
+
9494
+ **true**:禁止编辑填写控件
9495
+ **false**:(默认)允许编辑填写控件
9496
+ :type ForbidEditFillComponent: bool
9497
+ :param _SkipUploadFile: 跳过上传文件步骤
9498
+
9499
+ **true**:跳过
9500
+ **false**:(默认)不跳过,需要传ResourceId
9501
+ :type SkipUploadFile: str
9328
9502
  """
9329
9503
  self._CanEditFlow = None
9330
9504
  self._HideShowFlowName = None
@@ -9332,6 +9506,8 @@ class CreateFlowOption(AbstractModel):
9332
9506
  self._HideShowDeadline = None
9333
9507
  self._CanSkipAddApprover = None
9334
9508
  self._CustomCreateFlowDescription = None
9509
+ self._ForbidEditFillComponent = None
9510
+ self._SkipUploadFile = None
9335
9511
 
9336
9512
  @property
9337
9513
  def CanEditFlow(self):
@@ -9381,6 +9557,22 @@ class CreateFlowOption(AbstractModel):
9381
9557
  def CustomCreateFlowDescription(self, CustomCreateFlowDescription):
9382
9558
  self._CustomCreateFlowDescription = CustomCreateFlowDescription
9383
9559
 
9560
+ @property
9561
+ def ForbidEditFillComponent(self):
9562
+ return self._ForbidEditFillComponent
9563
+
9564
+ @ForbidEditFillComponent.setter
9565
+ def ForbidEditFillComponent(self, ForbidEditFillComponent):
9566
+ self._ForbidEditFillComponent = ForbidEditFillComponent
9567
+
9568
+ @property
9569
+ def SkipUploadFile(self):
9570
+ return self._SkipUploadFile
9571
+
9572
+ @SkipUploadFile.setter
9573
+ def SkipUploadFile(self, SkipUploadFile):
9574
+ self._SkipUploadFile = SkipUploadFile
9575
+
9384
9576
 
9385
9577
  def _deserialize(self, params):
9386
9578
  self._CanEditFlow = params.get("CanEditFlow")
@@ -9389,6 +9581,8 @@ class CreateFlowOption(AbstractModel):
9389
9581
  self._HideShowDeadline = params.get("HideShowDeadline")
9390
9582
  self._CanSkipAddApprover = params.get("CanSkipAddApprover")
9391
9583
  self._CustomCreateFlowDescription = params.get("CustomCreateFlowDescription")
9584
+ self._ForbidEditFillComponent = params.get("ForbidEditFillComponent")
9585
+ self._SkipUploadFile = params.get("SkipUploadFile")
9392
9586
  memeber_set = set(params.keys())
9393
9587
  for name, value in vars(self).items():
9394
9588
  property_name = name[1:]
@@ -9410,9 +9604,9 @@ class CreateFlowsByTemplatesRequest(AbstractModel):
9410
9604
 
9411
9605
  此接口下面信息必填。
9412
9606
  <ul>
9413
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
9414
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
9415
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
9607
+ <li>渠道应用标识: Agent.AppId</li>
9608
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
9609
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
9416
9610
  </ul>
9417
9611
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9418
9612
  :param _FlowInfos: 要创建的合同信息列表,最多支持一次创建20个合同
@@ -9427,7 +9621,7 @@ class CreateFlowsByTemplatesRequest(AbstractModel):
9427
9621
 
9428
9622
  :type NeedPreview: bool
9429
9623
  :param _PreviewType: 预览模式下产生的预览链接类型
9430
- <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
9624
+ <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
9431
9625
  <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
9432
9626
  注: `此参数在NeedPreview 为true时有效`
9433
9627
 
@@ -9896,6 +10090,16 @@ class CreateSignUrlsRequest(AbstractModel):
9896
10090
  :param _Mobile: 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
9897
10091
  注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
9898
10092
  :type Mobile: str
10093
+ :param _IdCardType: 证件类型,支持以下类型
10094
+ <ul><li>ID_CARD : 居民身份证</li>
10095
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
10096
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
10097
+ :type IdCardType: str
10098
+ :param _IdCardNumber: 证件号码,应符合以下规则
10099
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
10100
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
10101
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
10102
+ :type IdCardNumber: str
9899
10103
  :param _OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId
9900
10104
  注: `GenerateType为"CHANNEL"时必填`
9901
10105
  :type OrganizationOpenId: str
@@ -9929,6 +10133,8 @@ class CreateSignUrlsRequest(AbstractModel):
9929
10133
  self._OrganizationName = None
9930
10134
  self._Name = None
9931
10135
  self._Mobile = None
10136
+ self._IdCardType = None
10137
+ self._IdCardNumber = None
9932
10138
  self._OrganizationOpenId = None
9933
10139
  self._OpenId = None
9934
10140
  self._AutoJumpBack = None
@@ -10001,6 +10207,22 @@ class CreateSignUrlsRequest(AbstractModel):
10001
10207
  def Mobile(self, Mobile):
10002
10208
  self._Mobile = Mobile
10003
10209
 
10210
+ @property
10211
+ def IdCardType(self):
10212
+ return self._IdCardType
10213
+
10214
+ @IdCardType.setter
10215
+ def IdCardType(self, IdCardType):
10216
+ self._IdCardType = IdCardType
10217
+
10218
+ @property
10219
+ def IdCardNumber(self):
10220
+ return self._IdCardNumber
10221
+
10222
+ @IdCardNumber.setter
10223
+ def IdCardNumber(self, IdCardNumber):
10224
+ self._IdCardNumber = IdCardNumber
10225
+
10004
10226
  @property
10005
10227
  def OrganizationOpenId(self):
10006
10228
  return self._OrganizationOpenId
@@ -10073,6 +10295,8 @@ class CreateSignUrlsRequest(AbstractModel):
10073
10295
  self._OrganizationName = params.get("OrganizationName")
10074
10296
  self._Name = params.get("Name")
10075
10297
  self._Mobile = params.get("Mobile")
10298
+ self._IdCardType = params.get("IdCardType")
10299
+ self._IdCardNumber = params.get("IdCardNumber")
10076
10300
  self._OrganizationOpenId = params.get("OrganizationOpenId")
10077
10301
  self._OpenId = params.get("OpenId")
10078
10302
  self._AutoJumpBack = params.get("AutoJumpBack")
@@ -10484,6 +10708,113 @@ class DescribeChannelFlowEvidenceReportResponse(AbstractModel):
10484
10708
  self._RequestId = params.get("RequestId")
10485
10709
 
10486
10710
 
10711
+ class DescribeChannelSealPolicyWorkflowUrlRequest(AbstractModel):
10712
+ """DescribeChannelSealPolicyWorkflowUrl请求参数结构体
10713
+
10714
+ """
10715
+
10716
+ def __init__(self):
10717
+ r"""
10718
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
10719
+
10720
+ 此接口下面信息必填。
10721
+
10722
+ 渠道应用标识: Agent.AppId
10723
+ 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
10724
+ 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
10725
+ 第三方平台子客企业和员工必须已经经过实名认证
10726
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10727
+ :param _WorkflowInstanceId: 用印审批单的ID,可通过用印申请回调获取。
10728
+ :type WorkflowInstanceId: str
10729
+ :param _Endpoint: 生成链接的类型:
10730
+ 生成链接的类型
10731
+ <ul><li>**LongLink**:(默认)长链接,H5跳转到电子签小程序链接,链接有效期为1年</li>
10732
+ <li>**ShortLink**:H5跳转到电子签小程序链接,一般用于发送短信中带的链接,打开后进入腾讯电子签小程序,链接有效期为7天</li>
10733
+ <li>**App**:第三方APP或小程序跳转电子签小程序链接,一般用于贵方小程序或者APP跳转过来,打开后进入腾讯电子签小程序,链接有效期为1年</li></ul>
10734
+ :type Endpoint: str
10735
+ """
10736
+ self._Agent = None
10737
+ self._WorkflowInstanceId = None
10738
+ self._Endpoint = None
10739
+
10740
+ @property
10741
+ def Agent(self):
10742
+ return self._Agent
10743
+
10744
+ @Agent.setter
10745
+ def Agent(self, Agent):
10746
+ self._Agent = Agent
10747
+
10748
+ @property
10749
+ def WorkflowInstanceId(self):
10750
+ return self._WorkflowInstanceId
10751
+
10752
+ @WorkflowInstanceId.setter
10753
+ def WorkflowInstanceId(self, WorkflowInstanceId):
10754
+ self._WorkflowInstanceId = WorkflowInstanceId
10755
+
10756
+ @property
10757
+ def Endpoint(self):
10758
+ return self._Endpoint
10759
+
10760
+ @Endpoint.setter
10761
+ def Endpoint(self, Endpoint):
10762
+ self._Endpoint = Endpoint
10763
+
10764
+
10765
+ def _deserialize(self, params):
10766
+ if params.get("Agent") is not None:
10767
+ self._Agent = Agent()
10768
+ self._Agent._deserialize(params.get("Agent"))
10769
+ self._WorkflowInstanceId = params.get("WorkflowInstanceId")
10770
+ self._Endpoint = params.get("Endpoint")
10771
+ memeber_set = set(params.keys())
10772
+ for name, value in vars(self).items():
10773
+ property_name = name[1:]
10774
+ if property_name in memeber_set:
10775
+ memeber_set.remove(property_name)
10776
+ if len(memeber_set) > 0:
10777
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
10778
+
10779
+
10780
+
10781
+ class DescribeChannelSealPolicyWorkflowUrlResponse(AbstractModel):
10782
+ """DescribeChannelSealPolicyWorkflowUrl返回参数结构体
10783
+
10784
+ """
10785
+
10786
+ def __init__(self):
10787
+ r"""
10788
+ :param _WorkflowUrl: 用印审批小程序链接,链接类型(通过H5唤起小程序或通过APP跳转方式查看)。
10789
+ :type WorkflowUrl: str
10790
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
10791
+ :type RequestId: str
10792
+ """
10793
+ self._WorkflowUrl = None
10794
+ self._RequestId = None
10795
+
10796
+ @property
10797
+ def WorkflowUrl(self):
10798
+ return self._WorkflowUrl
10799
+
10800
+ @WorkflowUrl.setter
10801
+ def WorkflowUrl(self, WorkflowUrl):
10802
+ self._WorkflowUrl = WorkflowUrl
10803
+
10804
+ @property
10805
+ def RequestId(self):
10806
+ return self._RequestId
10807
+
10808
+ @RequestId.setter
10809
+ def RequestId(self, RequestId):
10810
+ self._RequestId = RequestId
10811
+
10812
+
10813
+ def _deserialize(self, params):
10814
+ self._WorkflowUrl = params.get("WorkflowUrl")
10815
+ self._RequestId = params.get("RequestId")
10816
+
10817
+
10487
10818
  class DescribeExtendedServiceAuthInfoRequest(AbstractModel):
10488
10819
  """DescribeExtendedServiceAuthInfo请求参数结构体
10489
10820
 
@@ -10900,7 +11231,7 @@ class DescribeTemplatesRequest(AbstractModel):
10900
11231
 
10901
11232
  可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
10902
11233
  :type TemplateId: str
10903
- :param _ContentType: 查询模版的内容
11234
+ :param _ContentType: 查询模板的内容
10904
11235
 
10905
11236
  <ul><li>**0**:(默认)模板列表及详情</li>
10906
11237
  <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
@@ -11561,8 +11892,8 @@ class FillApproverInfo(AbstractModel):
11561
11892
  :type OrganizationName: str
11562
11893
  :param _OrganizationOpenId: 企业OpenId
11563
11894
  :type OrganizationOpenId: str
11564
- :param _NotChannelOrganization: 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,organization_open_id+open_id 必传
11565
- :type NotChannelOrganization: str
11895
+ :param _NotChannelOrganization: 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,OrganizationOpenId 必传
11896
+ :type NotChannelOrganization: bool
11566
11897
  """
11567
11898
  self._RecipientId = None
11568
11899
  self._OpenId = None
@@ -12114,7 +12445,7 @@ class FlowApproverInfo(AbstractModel):
12114
12445
  <ul><li> **PERSON** :个人/自然人</li>
12115
12446
  <li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li>
12116
12447
  <li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li>
12117
- <li> **ENTERPRISESERVER** :企业/企业员自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
12448
+ <li> **ENTERPRISESERVER** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
12118
12449
 
12119
12450
  注:
12120
12451
  `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
@@ -12149,7 +12480,7 @@ class FlowApproverInfo(AbstractModel):
12149
12480
  :type PreReadTime: int
12150
12481
  :param _JumpUrl: 签署完前端跳转的url,此字段的用法场景请联系客户经理确认
12151
12482
  :type JumpUrl: str
12152
- :param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
12483
+ :param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人、是否为动态补充签署人等。
12153
12484
  详细操作可以参考开发者中心的ApproverOption结构体。
12154
12485
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
12155
12486
  :param _ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
@@ -12169,7 +12500,9 @@ class FlowApproverInfo(AbstractModel):
12169
12500
 
12170
12501
  默认为1(人脸认证 ),2(签署密码)
12171
12502
 
12172
- 注: `用模版创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在此创建合同指定无效`
12503
+ 注:
12504
+ 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
12505
+ 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
12173
12506
  :type ApproverSignTypes: list of int
12174
12507
  :param _SignId: 签署ID
12175
12508
  - 发起流程时系统自动补充
@@ -13125,6 +13458,7 @@ class FlowInfo(AbstractModel):
13125
13458
  示例值:1604912664
13126
13459
  :type Deadline: int
13127
13460
  :param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
13461
+ 如果使用模板发起接口,此参数为必填。
13128
13462
 
13129
13463
  可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
13130
13464
  :type TemplateId: str
@@ -13162,8 +13496,6 @@ class FlowInfo(AbstractModel):
13162
13496
 
13163
13497
  :type CustomShowMap: str
13164
13498
  :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
13165
-
13166
- 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
13167
13499
  :type CcInfos: list of CcInfo
13168
13500
  :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
13169
13501
  <ul><li> **false**:(默认)不需要审批,直接签署。</li>
@@ -14089,32 +14421,35 @@ class OperateChannelTemplateRequest(AbstractModel):
14089
14421
  <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
14090
14422
  </ul>
14091
14423
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
14092
- :param _OperateType: 操作类型,
14424
+ :param _OperateType: 操作类型,可取值如下:
14093
14425
  <ul>
14094
- <li>查询:"SELECT"</li>
14095
- <li>删除:"DELETE"</li>
14096
- <li>更新:"UPDATE"</li>
14426
+ <li>SELECT: 查询</li>
14427
+ <li>DELETE: 删除</li>
14428
+ <li>UPDATE: 更新</li>
14097
14429
  </ul>
14098
14430
  :type OperateType: str
14099
- :param _TemplateId: 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
14431
+ :param _TemplateId: 合同模板ID,为32位字符串。
14432
+ 注: ` 此处为第三方应用平台模板库模板ID,非子客模板ID`
14100
14433
  :type TemplateId: str
14101
- :param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
14102
-
14103
- 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
14434
+ :param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识,支持批量(用,分割),
14104
14435
  :type ProxyOrganizationOpenIds: str
14105
- :param _AuthTag: 模板可见性,
14106
- <ul>
14107
- <li>全部可见-"all"</li>
14108
- <li>部分可见-"part"</li>
14109
- </ul>
14436
+ :param _AuthTag: 模板可见范围, 可以设置的值如下:
14437
+
14438
+ **all**: 所有本第三方应用合作企业可见
14439
+ **part**: 指定的本第三方应用合作企业
14440
+
14441
+ 对应控制台的位置
14442
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/68b97812c68d6af77a5991e3bff5c790.png)
14443
+
14110
14444
  :type AuthTag: str
14111
14445
  :param _Available: 当OperateType=UPDATE时,可以通过设置此字段对模板启停用状态进行操作。
14112
14446
  <ul>
14113
- <li>若此字段值为0,则不会修改模板Available</li>
14114
- <li>1为启用模板</li>
14115
- <li>2为停用模板</li>
14447
+ <li>0: 不修改模板可用状态</li>
14448
+ <li>1: 启用模板</li>
14449
+ <li>2: 停用模板</li>
14116
14450
  </ul>
14117
14451
  启用后模板可以正常领取。
14452
+
14118
14453
  停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
14119
14454
  如果Available更新失败,会直接返回错误。
14120
14455
  :type Available: int
@@ -14219,30 +14554,26 @@ class OperateChannelTemplateResponse(AbstractModel):
14219
14554
 
14220
14555
  def __init__(self):
14221
14556
  r"""
14222
- :param _AppId: 腾讯电子签颁发给第三方应用平台的应用ID
14557
+ :param _AppId: 第三方应用平台的应用ID
14223
14558
  注意:此字段可能返回 null,表示取不到有效值。
14224
14559
  :type AppId: str
14225
- :param _TemplateId: 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
14560
+ :param _TemplateId: 合同模板ID
14226
14561
  注意:此字段可能返回 null,表示取不到有效值。
14227
14562
  :type TemplateId: str
14228
- :param _OperateResult: 描述模板可见性更改的结果,和参数中Available无关。
14563
+ :param _OperateResult: 描述模板可见性更改的结果。
14229
14564
  <ul>
14230
- <li>全部成功-"all-success"</li>
14231
- <li>部分成功-"part-success"</li>
14232
- <li>全部失败-"fail",失败的会在FailMessageList中展示</li>
14565
+ <li>all-success: 全部成功</li>
14566
+ <li>part-success: 部分成功,失败的会在FailMessageList中展示</li>
14567
+ <li>fail:全部失败, 失败的会在FailMessageList中展示</li>
14233
14568
  </ul>
14234
14569
  注意:此字段可能返回 null,表示取不到有效值。
14235
14570
  :type OperateResult: str
14236
- :param _AuthTag: 模板可见性,
14237
- <ul>
14238
- <li>全部可见-"all"</li>
14239
- <li>部分可见-"part"</li>
14240
- </ul>
14571
+ :param _AuthTag: 模板可见范围:
14572
+ **all**: 所有本第三方应用合作企业可见
14573
+ **part**: 指定的本第三方应用合作企业
14241
14574
  注意:此字段可能返回 null,表示取不到有效值。
14242
14575
  :type AuthTag: str
14243
- :param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
14244
-
14245
- 一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
14576
+ :param _ProxyOrganizationOpenIds: 第三方平台子客企业标识列表
14246
14577
  注意:此字段可能返回 null,表示取不到有效值。
14247
14578
  :type ProxyOrganizationOpenIds: list of str
14248
14579
  :param _FailMessageList: 操作失败信息数组