tencentcloud-sdk-python-essbasic 3.1.120__py2.py3-none-any.whl → 3.1.126__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.
tencentcloud/__init__.py CHANGED
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.120'
17
+ __version__ = '3.1.126'
@@ -56,6 +56,43 @@ class EssbasicClient(AbstractClient):
56
56
  raise TencentCloudSDKException(type(e).__name__, str(e))
57
57
 
58
58
 
59
+ def CancelOrganizationFlows(self, request):
60
+ r"""全量撤销企业所有签署中的合同,单次任务最多支持撤销3000份合同。
61
+
62
+ 适用场景:在企业信息变更场景下,签署中的合同需要全部撤销,全部重新发起,则可通过该接口取消签署中的合同流程,<font color='red'>需注意:该接口会将企业下签署中的合同都进行撤销操作,谨慎使用此接口。</font>
63
+
64
+ - **可撤回合同状态**:未全部签署完成
65
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
66
+
67
+ 批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign/#%E5%8D%81%E4%BA%8C-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
68
+
69
+
70
+ 注:
71
+ - 有对应合同撤销权限的人: <font color='red'>**发起人所在企业的超管、法人**</font>
72
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
73
+ - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
74
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
75
+
76
+ :param request: Request instance for CancelOrganizationFlows.
77
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.CancelOrganizationFlowsRequest`
78
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.CancelOrganizationFlowsResponse`
79
+
80
+ """
81
+ try:
82
+ params = request._serialize()
83
+ headers = request.headers
84
+ body = self.call("CancelOrganizationFlows", params, headers=headers)
85
+ response = json.loads(body)
86
+ model = models.CancelOrganizationFlowsResponse()
87
+ model._deserialize(response["Response"])
88
+ return model
89
+ except Exception as e:
90
+ if isinstance(e, TencentCloudSDKException):
91
+ raise
92
+ else:
93
+ raise TencentCloudSDKException(type(e).__name__, str(e))
94
+
95
+
59
96
  def ChannelBatchCancelFlows(self, request):
60
97
  r"""通过合同编号批量撤销合同,单次最多支持撤销100份合同。
61
98
 
@@ -50,6 +50,38 @@ class EssbasicClient(AbstractClient):
50
50
 
51
51
  return await self.call_and_deserialize(**kwargs)
52
52
 
53
+ async def CancelOrganizationFlows(
54
+ self,
55
+ request: models.CancelOrganizationFlowsRequest,
56
+ opts: Dict = None,
57
+ ) -> models.CancelOrganizationFlowsResponse:
58
+ """
59
+ 全量撤销企业所有签署中的合同,单次任务最多支持撤销3000份合同。
60
+
61
+ 适用场景:在企业信息变更场景下,签署中的合同需要全部撤销,全部重新发起,则可通过该接口取消签署中的合同流程,<font color='red'>需注意:该接口会将企业下签署中的合同都进行撤销操作,谨慎使用此接口。</font>
62
+
63
+ - **可撤回合同状态**:未全部签署完成
64
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
65
+
66
+ 批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign/#%E5%8D%81%E4%BA%8C-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
67
+
68
+
69
+ 注:
70
+ - 有对应合同撤销权限的人: <font color='red'>**发起人所在企业的超管、法人**</font>
71
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
72
+ - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
73
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
74
+ """
75
+
76
+ kwargs = {}
77
+ kwargs["action"] = "CancelOrganizationFlows"
78
+ kwargs["params"] = request._serialize()
79
+ kwargs["resp_cls"] = models.CancelOrganizationFlowsResponse
80
+ kwargs["headers"] = request.headers
81
+ kwargs["opts"] = opts or {}
82
+
83
+ return await self.call_and_deserialize(**kwargs)
84
+
53
85
  async def ChannelBatchCancelFlows(
54
86
  self,
55
87
  request: models.ChannelBatchCancelFlowsRequest,
@@ -1449,17 +1449,20 @@ class CancelFailureFlow(AbstractModel):
1449
1449
 
1450
1450
  def __init__(self):
1451
1451
  r"""
1452
- :param _FlowId: 签署流程编号,为32位字符串
1452
+ :param _FlowId: <p>签署流程编号,为32位字符串</p>
1453
1453
  :type FlowId: str
1454
- :param _Reason: 撤销失败原因
1454
+ :param _Reason: <p>撤销失败原因</p>
1455
1455
  :type Reason: str
1456
+ :param _FlowName: <p>合同流程名称</p>
1457
+ :type FlowName: str
1456
1458
  """
1457
1459
  self._FlowId = None
1458
1460
  self._Reason = None
1461
+ self._FlowName = None
1459
1462
 
1460
1463
  @property
1461
1464
  def FlowId(self):
1462
- r"""签署流程编号,为32位字符串
1465
+ r"""<p>签署流程编号,为32位字符串</p>
1463
1466
  :rtype: str
1464
1467
  """
1465
1468
  return self._FlowId
@@ -1470,7 +1473,7 @@ class CancelFailureFlow(AbstractModel):
1470
1473
 
1471
1474
  @property
1472
1475
  def Reason(self):
1473
- r"""撤销失败原因
1476
+ r"""<p>撤销失败原因</p>
1474
1477
  :rtype: str
1475
1478
  """
1476
1479
  return self._Reason
@@ -1479,10 +1482,22 @@ class CancelFailureFlow(AbstractModel):
1479
1482
  def Reason(self, Reason):
1480
1483
  self._Reason = Reason
1481
1484
 
1485
+ @property
1486
+ def FlowName(self):
1487
+ r"""<p>合同流程名称</p>
1488
+ :rtype: str
1489
+ """
1490
+ return self._FlowName
1491
+
1492
+ @FlowName.setter
1493
+ def FlowName(self, FlowName):
1494
+ self._FlowName = FlowName
1495
+
1482
1496
 
1483
1497
  def _deserialize(self, params):
1484
1498
  self._FlowId = params.get("FlowId")
1485
1499
  self._Reason = params.get("Reason")
1500
+ self._FlowName = params.get("FlowName")
1486
1501
  memeber_set = set(params.keys())
1487
1502
  for name, value in vars(self).items():
1488
1503
  property_name = name[1:]
@@ -1493,6 +1508,117 @@ class CancelFailureFlow(AbstractModel):
1493
1508
 
1494
1509
 
1495
1510
 
1511
+ class CancelOrganizationFlowsRequest(AbstractModel):
1512
+ r"""CancelOrganizationFlows请求参数结构体
1513
+
1514
+ """
1515
+
1516
+ def __init__(self):
1517
+ r"""
1518
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证</p>
1519
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1520
+ :param _CancelMessage: <p>撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。备注:<code>如果不传递撤回原因,那么默认撤回原因是 &quot;自动撤销(通过接口实现)&quot;</code></p>
1521
+ :type CancelMessage: str
1522
+ :param _CancelMessageFormat: <p>撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:<strong>0</strong> : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同<strong>1</strong> : 合同封面页面会展示为: 发起方以<strong>CancelMessage</strong>的理由撤销当前合同<strong>2</strong> : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同<strong>3</strong> : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: <code>CancelMessage为撤销当前合同的理由</code><img src="https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png" alt="image"></p><p>枚举值:</p><ul><li>0: 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同</li><li>1: 合同封面页面会展示为: 发起方以<strong>CancelMessage</strong>的理由撤销当前合同</li><li>2: 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同</li><li>3: 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: `CancelMessage为撤销当前合同的理由</li></ul>
1523
+ :type CancelMessageFormat: int
1524
+ """
1525
+ self._Agent = None
1526
+ self._CancelMessage = None
1527
+ self._CancelMessageFormat = None
1528
+
1529
+ @property
1530
+ def Agent(self):
1531
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证</p>
1532
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1533
+ """
1534
+ return self._Agent
1535
+
1536
+ @Agent.setter
1537
+ def Agent(self, Agent):
1538
+ self._Agent = Agent
1539
+
1540
+ @property
1541
+ def CancelMessage(self):
1542
+ r"""<p>撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。备注:<code>如果不传递撤回原因,那么默认撤回原因是 &quot;自动撤销(通过接口实现)&quot;</code></p>
1543
+ :rtype: str
1544
+ """
1545
+ return self._CancelMessage
1546
+
1547
+ @CancelMessage.setter
1548
+ def CancelMessage(self, CancelMessage):
1549
+ self._CancelMessage = CancelMessage
1550
+
1551
+ @property
1552
+ def CancelMessageFormat(self):
1553
+ r"""<p>撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:<strong>0</strong> : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同<strong>1</strong> : 合同封面页面会展示为: 发起方以<strong>CancelMessage</strong>的理由撤销当前合同<strong>2</strong> : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同<strong>3</strong> : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: <code>CancelMessage为撤销当前合同的理由</code><img src="https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png" alt="image"></p><p>枚举值:</p><ul><li>0: 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同</li><li>1: 合同封面页面会展示为: 发起方以<strong>CancelMessage</strong>的理由撤销当前合同</li><li>2: 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同</li><li>3: 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: `CancelMessage为撤销当前合同的理由</li></ul>
1554
+ :rtype: int
1555
+ """
1556
+ return self._CancelMessageFormat
1557
+
1558
+ @CancelMessageFormat.setter
1559
+ def CancelMessageFormat(self, CancelMessageFormat):
1560
+ self._CancelMessageFormat = CancelMessageFormat
1561
+
1562
+
1563
+ def _deserialize(self, params):
1564
+ if params.get("Agent") is not None:
1565
+ self._Agent = Agent()
1566
+ self._Agent._deserialize(params.get("Agent"))
1567
+ self._CancelMessage = params.get("CancelMessage")
1568
+ self._CancelMessageFormat = params.get("CancelMessageFormat")
1569
+ memeber_set = set(params.keys())
1570
+ for name, value in vars(self).items():
1571
+ property_name = name[1:]
1572
+ if property_name in memeber_set:
1573
+ memeber_set.remove(property_name)
1574
+ if len(memeber_set) > 0:
1575
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
1576
+
1577
+
1578
+
1579
+ class CancelOrganizationFlowsResponse(AbstractModel):
1580
+ r"""CancelOrganizationFlows返回参数结构体
1581
+
1582
+ """
1583
+
1584
+ def __init__(self):
1585
+ r"""
1586
+ :param _TaskId: <p>全量撤销企业合同任务编号,为32位字符串,可用于<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign/#%E5%8D%81%E4%BA%8C-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">全量撤销任务结果回调</a></p>
1587
+ :type TaskId: str
1588
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1589
+ :type RequestId: str
1590
+ """
1591
+ self._TaskId = None
1592
+ self._RequestId = None
1593
+
1594
+ @property
1595
+ def TaskId(self):
1596
+ r"""<p>全量撤销企业合同任务编号,为32位字符串,可用于<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign/#%E5%8D%81%E4%BA%8C-%E5%85%A8%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">全量撤销任务结果回调</a></p>
1597
+ :rtype: str
1598
+ """
1599
+ return self._TaskId
1600
+
1601
+ @TaskId.setter
1602
+ def TaskId(self, TaskId):
1603
+ self._TaskId = TaskId
1604
+
1605
+ @property
1606
+ def RequestId(self):
1607
+ r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1608
+ :rtype: str
1609
+ """
1610
+ return self._RequestId
1611
+
1612
+ @RequestId.setter
1613
+ def RequestId(self, RequestId):
1614
+ self._RequestId = RequestId
1615
+
1616
+
1617
+ def _deserialize(self, params):
1618
+ self._TaskId = params.get("TaskId")
1619
+ self._RequestId = params.get("RequestId")
1620
+
1621
+
1496
1622
  class CcInfo(AbstractModel):
1497
1623
  r"""抄送信息
1498
1624
 
@@ -2717,7 +2843,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2717
2843
  :type CacheApproverInfo: bool
2718
2844
  :param _CanBatchReject: <p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注:<code>当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作,以达到拒签整个合同组的效果。</code></p>
2719
2845
  :type CanBatchReject: bool
2720
- :param _PresetApproverInfo: <p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。</p>
2846
+ :param _PresetApproverInfo: <p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。若为个人动态签署方,支持预设姓名、证件、手机号。若为企业员工动态签署方,仅支持预设企业名称(仅限预设SaaS企业参与方,不支持子客企业)。</p>
2721
2847
  :type PresetApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.PresetApproverInfo`
2722
2848
  :param _CanSkipReadFlow: <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul>注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 若批量签署的合同中第一份待签署合同所选择的印章或者签名无法完全覆盖后续合同要求,或者当前签署人没有指定印章使用权限,则无法使用此功能,会自动退化为逐份确认。</code></p>
2723
2849
  :type CanSkipReadFlow: bool
@@ -2886,7 +3012,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2886
3012
 
2887
3013
  @property
2888
3014
  def PresetApproverInfo(self):
2889
- r"""<p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。</p>
3015
+ r"""<p>预设的动态签署方的补充信息,仅匹配对应信息的签署方才能领取合同。若为个人动态签署方,支持预设姓名、证件、手机号。若为企业员工动态签署方,仅支持预设企业名称(仅限预设SaaS企业参与方,不支持子客企业)。</p>
2890
3016
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.PresetApproverInfo`
2891
3017
  """
2892
3018
  return self._PresetApproverInfo
@@ -18515,33 +18641,20 @@ class DescribeCancelFlowsTaskRequest(AbstractModel):
18515
18641
 
18516
18642
  def __init__(self):
18517
18643
  r"""
18518
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
18519
-
18520
- 此接口下面信息必填。
18521
- <ul>
18522
- <li>渠道应用标识: Agent.AppId</li>
18523
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
18524
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
18525
- </ul>
18526
- 第三方平台子客企业和员工必须已经经过实名认证
18644
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
18527
18645
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
18528
- :param _TaskId: 批量撤销任务编号,为32位字符串,通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)获得。
18646
+ :param _TaskId: <p>批量撤销任务编号,为32位字符串,通过接口<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows">批量撤销合同流程</a>或者<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl">获取批量撤销签署流程腾讯电子签小程序链接</a>或者<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/CancelOrganizationFlows">全量撤销企业合同</a>获得。</p>
18529
18647
  :type TaskId: str
18648
+ :param _CancelType: <p>撤销任务类型</p><p>枚举值:</p><ul><li>0: 默认类型,批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务</li><li>1: 全量撤销任务</li></ul><p>枚举值:</p><ul><li>0: 默认类型,批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务</li><li>1: 全量撤销任务</li></ul>
18649
+ :type CancelType: int
18530
18650
  """
18531
18651
  self._Agent = None
18532
18652
  self._TaskId = None
18653
+ self._CancelType = None
18533
18654
 
18534
18655
  @property
18535
18656
  def Agent(self):
18536
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
18537
-
18538
- 此接口下面信息必填。
18539
- <ul>
18540
- <li>渠道应用标识: Agent.AppId</li>
18541
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
18542
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
18543
- </ul>
18544
- 第三方平台子客企业和员工必须已经经过实名认证
18657
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
18545
18658
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
18546
18659
  """
18547
18660
  return self._Agent
@@ -18552,7 +18665,7 @@ class DescribeCancelFlowsTaskRequest(AbstractModel):
18552
18665
 
18553
18666
  @property
18554
18667
  def TaskId(self):
18555
- r"""批量撤销任务编号,为32位字符串,通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)获得。
18668
+ r"""<p>批量撤销任务编号,为32位字符串,通过接口<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows">批量撤销合同流程</a>或者<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl">获取批量撤销签署流程腾讯电子签小程序链接</a>或者<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/CancelOrganizationFlows">全量撤销企业合同</a>获得。</p>
18556
18669
  :rtype: str
18557
18670
  """
18558
18671
  return self._TaskId
@@ -18561,12 +18674,24 @@ class DescribeCancelFlowsTaskRequest(AbstractModel):
18561
18674
  def TaskId(self, TaskId):
18562
18675
  self._TaskId = TaskId
18563
18676
 
18677
+ @property
18678
+ def CancelType(self):
18679
+ r"""<p>撤销任务类型</p><p>枚举值:</p><ul><li>0: 默认类型,批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务</li><li>1: 全量撤销任务</li></ul><p>枚举值:</p><ul><li>0: 默认类型,批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务</li><li>1: 全量撤销任务</li></ul>
18680
+ :rtype: int
18681
+ """
18682
+ return self._CancelType
18683
+
18684
+ @CancelType.setter
18685
+ def CancelType(self, CancelType):
18686
+ self._CancelType = CancelType
18687
+
18564
18688
 
18565
18689
  def _deserialize(self, params):
18566
18690
  if params.get("Agent") is not None:
18567
18691
  self._Agent = Agent()
18568
18692
  self._Agent._deserialize(params.get("Agent"))
18569
18693
  self._TaskId = params.get("TaskId")
18694
+ self._CancelType = params.get("CancelType")
18570
18695
  memeber_set = set(params.keys())
18571
18696
  for name, value in vars(self).items():
18572
18697
  property_name = name[1:]
@@ -18584,13 +18709,13 @@ class DescribeCancelFlowsTaskResponse(AbstractModel):
18584
18709
 
18585
18710
  def __init__(self):
18586
18711
  r"""
18587
- :param _TaskId: 批量撤销任务编号,为32位字符串。
18712
+ :param _TaskId: <p>批量撤销任务编号,为32位字符串。</p>
18588
18713
  :type TaskId: str
18589
- :param _TaskStatus: 任务状态,需要关注的状态<ul><li>**PROCESSING** - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul>
18714
+ :param _TaskStatus: <p>任务状态,需要关注的状态<ul><li><strong>PROCESSING</strong> - 任务执行中</li><li><strong>END</strong> - 任务处理完成</li><li><strong>TIMEOUT</strong> 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul></p>
18590
18715
  :type TaskStatus: str
18591
- :param _SuccessFlowIds: 批量撤销成功的签署流程编号
18716
+ :param _SuccessFlowIds: <p>批量撤销成功的签署流程编号</p>
18592
18717
  :type SuccessFlowIds: list of str
18593
- :param _FailureFlows: 批量撤销失败的签署流程信息
18718
+ :param _FailureFlows: <p>批量撤销失败的签署流程信息</p>
18594
18719
  :type FailureFlows: list of CancelFailureFlow
18595
18720
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18596
18721
  :type RequestId: str
@@ -18603,7 +18728,7 @@ class DescribeCancelFlowsTaskResponse(AbstractModel):
18603
18728
 
18604
18729
  @property
18605
18730
  def TaskId(self):
18606
- r"""批量撤销任务编号,为32位字符串。
18731
+ r"""<p>批量撤销任务编号,为32位字符串。</p>
18607
18732
  :rtype: str
18608
18733
  """
18609
18734
  return self._TaskId
@@ -18614,7 +18739,7 @@ class DescribeCancelFlowsTaskResponse(AbstractModel):
18614
18739
 
18615
18740
  @property
18616
18741
  def TaskStatus(self):
18617
- r"""任务状态,需要关注的状态<ul><li>**PROCESSING** - 任务执行中</li><li>**END** - 任务处理完成</li><li>**TIMEOUT** 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul>
18742
+ r"""<p>任务状态,需要关注的状态<ul><li><strong>PROCESSING</strong> - 任务执行中</li><li><strong>END</strong> - 任务处理完成</li><li><strong>TIMEOUT</strong> 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul></p>
18618
18743
  :rtype: str
18619
18744
  """
18620
18745
  return self._TaskStatus
@@ -18625,7 +18750,7 @@ class DescribeCancelFlowsTaskResponse(AbstractModel):
18625
18750
 
18626
18751
  @property
18627
18752
  def SuccessFlowIds(self):
18628
- r"""批量撤销成功的签署流程编号
18753
+ r"""<p>批量撤销成功的签署流程编号</p>
18629
18754
  :rtype: list of str
18630
18755
  """
18631
18756
  return self._SuccessFlowIds
@@ -18636,7 +18761,7 @@ class DescribeCancelFlowsTaskResponse(AbstractModel):
18636
18761
 
18637
18762
  @property
18638
18763
  def FailureFlows(self):
18639
- r"""批量撤销失败的签署流程信息
18764
+ r"""<p>批量撤销失败的签署流程信息</p>
18640
18765
  :rtype: list of CancelFailureFlow
18641
18766
  """
18642
18767
  return self._FailureFlows
@@ -27884,29 +28009,26 @@ class PresetApproverInfo(AbstractModel):
27884
28009
 
27885
28010
  def __init__(self):
27886
28011
  r"""
27887
- :param _Name: 预设参与方姓名。
28012
+ :param _Name: <p>预设参与方姓名。</p>
27888
28013
  :type Name: str
27889
- :param _Mobile: 预设参与方手机号。
28014
+ :param _Mobile: <p>预设参与方手机号。</p>
27890
28015
  :type Mobile: str
27891
- :param _IdCardNumber: 预设参与方证件号,需要和IdCardType同时传入。
27892
-
27893
- 证件号码,应符合以下规则
27894
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
28016
+ :param _IdCardNumber: <p>预设参与方证件号,需要和IdCardType同时传入。</p><p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
27895
28017
  :type IdCardNumber: str
27896
- :param _IdCardType: 预设参与方的证件类型,需要与IdCardNumber同时传入。
27897
-
27898
- 证件类型,支持以下类型
27899
- <ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
28018
+ :param _IdCardType: <p>预设参与方的证件类型,需要与IdCardNumber同时传入。</p><p>证件类型,支持以下类型</p><ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
27900
28019
  :type IdCardType: str
28020
+ :param _OrganizationName: <p>企业用户动态签署方场景指定预设企业名称。<code>注意:1. 若为企业动态签署方场景,此参数必须要指定。2. 企业动态签署方场景暂不支持指定姓名证件手机号等参数,仅支持指定企业名称。3. 暂不支持指定子客企业,此处预设的企业仅支持SaaS企业。</code></p>
28021
+ :type OrganizationName: str
27901
28022
  """
27902
28023
  self._Name = None
27903
28024
  self._Mobile = None
27904
28025
  self._IdCardNumber = None
27905
28026
  self._IdCardType = None
28027
+ self._OrganizationName = None
27906
28028
 
27907
28029
  @property
27908
28030
  def Name(self):
27909
- r"""预设参与方姓名。
28031
+ r"""<p>预设参与方姓名。</p>
27910
28032
  :rtype: str
27911
28033
  """
27912
28034
  return self._Name
@@ -27917,7 +28039,7 @@ class PresetApproverInfo(AbstractModel):
27917
28039
 
27918
28040
  @property
27919
28041
  def Mobile(self):
27920
- r"""预设参与方手机号。
28042
+ r"""<p>预设参与方手机号。</p>
27921
28043
  :rtype: str
27922
28044
  """
27923
28045
  return self._Mobile
@@ -27928,10 +28050,7 @@ class PresetApproverInfo(AbstractModel):
27928
28050
 
27929
28051
  @property
27930
28052
  def IdCardNumber(self):
27931
- r"""预设参与方证件号,需要和IdCardType同时传入。
27932
-
27933
- 证件号码,应符合以下规则
27934
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
28053
+ r"""<p>预设参与方证件号,需要和IdCardType同时传入。</p><p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
27935
28054
  :rtype: str
27936
28055
  """
27937
28056
  return self._IdCardNumber
@@ -27942,10 +28061,7 @@ class PresetApproverInfo(AbstractModel):
27942
28061
 
27943
28062
  @property
27944
28063
  def IdCardType(self):
27945
- r"""预设参与方的证件类型,需要与IdCardNumber同时传入。
27946
-
27947
- 证件类型,支持以下类型
27948
- <ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
28064
+ r"""<p>预设参与方的证件类型,需要与IdCardNumber同时传入。</p><p>证件类型,支持以下类型</p><ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
27949
28065
  :rtype: str
27950
28066
  """
27951
28067
  return self._IdCardType
@@ -27954,12 +28070,24 @@ class PresetApproverInfo(AbstractModel):
27954
28070
  def IdCardType(self, IdCardType):
27955
28071
  self._IdCardType = IdCardType
27956
28072
 
28073
+ @property
28074
+ def OrganizationName(self):
28075
+ r"""<p>企业用户动态签署方场景指定预设企业名称。<code>注意:1. 若为企业动态签署方场景,此参数必须要指定。2. 企业动态签署方场景暂不支持指定姓名证件手机号等参数,仅支持指定企业名称。3. 暂不支持指定子客企业,此处预设的企业仅支持SaaS企业。</code></p>
28076
+ :rtype: str
28077
+ """
28078
+ return self._OrganizationName
28079
+
28080
+ @OrganizationName.setter
28081
+ def OrganizationName(self, OrganizationName):
28082
+ self._OrganizationName = OrganizationName
28083
+
27957
28084
 
27958
28085
  def _deserialize(self, params):
27959
28086
  self._Name = params.get("Name")
27960
28087
  self._Mobile = params.get("Mobile")
27961
28088
  self._IdCardNumber = params.get("IdCardNumber")
27962
28089
  self._IdCardType = params.get("IdCardType")
28090
+ self._OrganizationName = params.get("OrganizationName")
27963
28091
  memeber_set = set(params.keys())
27964
28092
  for name, value in vars(self).items():
27965
28093
  property_name = name[1:]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.1.120
3
+ Version: 3.1.126
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common <4.0.0,>=3.1.120
18
+ Requires-Dist: tencentcloud-sdk-python-common <4.0.0,>=3.1.126
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -1,4 +1,4 @@
1
- tencentcloud/__init__.py,sha256=RdPZ73XSpRZ1_wvtvuLEqtzXbFuB6VeyjFXOmF5lnT8,630
1
+ tencentcloud/__init__.py,sha256=o8_2yZ-gjZjrB7-jQDEOQUgkDBxks5ldwIcf8nvg8Hw,630
2
2
  tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
3
  tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
4
  tencentcloud/essbasic/v20201222/errorcodes.py,sha256=_HaXGynY1ocz-dbY7C6IOlNUWmNMu9XsY-x11g3Rm-w,5365
@@ -7,10 +7,10 @@ tencentcloud/essbasic/v20201222/essbasic_client_async.py,sha256=FDF4CJifYy6IfhH6
7
7
  tencentcloud/essbasic/v20201222/models.py,sha256=P2ayL06cP1AmBPL9CbzFr9gO2naGrVFsa2RLHnN0QDc,335467
8
8
  tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
9
  tencentcloud/essbasic/v20210526/errorcodes.py,sha256=ejaP5Fp9_mKfUbeS3JYy3bwHPt6X5I-yiO3kgSTckN0,19833
10
- tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=xheFyMQtZ_sYGIVhCwn7XNHnXbpcPNRIeKzvrb_zKH0,176224
11
- tencentcloud/essbasic/v20210526/essbasic_client_async.py,sha256=zst0R1_rQ8uiq-lvQOg4nWiRpl43mA11UyWeEg-BhcY,146213
12
- tencentcloud/essbasic/v20210526/models.py,sha256=z4B1C6VAnMYSJ6oV0ZaCh7rW06jPD0bDkufFrtHCVw4,1390443
13
- tencentcloud_sdk_python_essbasic-3.1.120.dist-info/METADATA,sha256=M4oDTQHksVQHLBdoDJkehWsMmXh5mWpIgJPLfq4Yr1g,1522
14
- tencentcloud_sdk_python_essbasic-3.1.120.dist-info/WHEEL,sha256=a5ogxI61vGGBHYbAAwISCXsfU7mxKr76gTpCEmSNOI8,109
15
- tencentcloud_sdk_python_essbasic-3.1.120.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
16
- tencentcloud_sdk_python_essbasic-3.1.120.dist-info/RECORD,,
10
+ tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=fNyMaVHhA3ij-5hezgbtvSEZ7M36IXR0ZUhLWHQqDeg,178905
11
+ tencentcloud/essbasic/v20210526/essbasic_client_async.py,sha256=IIypj4Po6dEIv3PKULdfeiIDA_dzaGMRnKEi2foEBWA,148579
12
+ tencentcloud/essbasic/v20210526/models.py,sha256=d_xCcu--1lS1DOeSsyRmMiyke6mF-Adr7SSDThKZ8rI,1402866
13
+ tencentcloud_sdk_python_essbasic-3.1.126.dist-info/METADATA,sha256=Ml1dc4Z4ioXWsPjzK2LzSBgqVkAktxHPEVS2UG2_Sd0,1522
14
+ tencentcloud_sdk_python_essbasic-3.1.126.dist-info/WHEEL,sha256=a5ogxI61vGGBHYbAAwISCXsfU7mxKr76gTpCEmSNOI8,109
15
+ tencentcloud_sdk_python_essbasic-3.1.126.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
16
+ tencentcloud_sdk_python_essbasic-3.1.126.dist-info/RECORD,,