tencentcloud-sdk-python 3.0.1015__py2.py3-none-any.whl → 3.0.1017__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.

Potentially problematic release.


This version of tencentcloud-sdk-python might be problematic. Click here for more details.

Files changed (27) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/ccc/v20200210/models.py +29 -0
  3. tencentcloud/clb/v20180317/errorcodes.py +3 -0
  4. tencentcloud/csip/v20221121/models.py +39 -0
  5. tencentcloud/dnspod/v20210323/dnspod_client.py +92 -0
  6. tencentcloud/dnspod/v20210323/errorcodes.py +33 -0
  7. tencentcloud/dnspod/v20210323/models.py +462 -0
  8. tencentcloud/drm/v20181115/drm_client.py +23 -0
  9. tencentcloud/drm/v20181115/models.py +118 -0
  10. tencentcloud/ess/v20201111/ess_client.py +30 -0
  11. tencentcloud/ess/v20201111/models.py +172 -3
  12. tencentcloud/essbasic/v20210526/errorcodes.py +3 -0
  13. tencentcloud/essbasic/v20210526/essbasic_client.py +101 -42
  14. tencentcloud/essbasic/v20210526/models.py +479 -133
  15. tencentcloud/facefusion/v20181201/models.py +5 -4
  16. tencentcloud/tdmq/v20200217/models.py +582 -0
  17. tencentcloud/tdmq/v20200217/tdmq_client.py +69 -0
  18. tencentcloud/teo/v20220901/models.py +1 -1
  19. tencentcloud/tione/v20211111/models.py +62 -0
  20. tencentcloud/vpc/v20170312/models.py +17 -3
  21. tencentcloud/vrs/v20200824/models.py +26 -1
  22. tencentcloud/waf/v20180125/waf_client.py +6 -2
  23. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/METADATA +1 -1
  24. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/RECORD +27 -27
  25. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/LICENSE +0 -0
  26. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/WHEEL +0 -0
  27. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/top_level.txt +0 -0
@@ -229,6 +229,8 @@ class ApproverOption(AbstractModel):
229
229
 
230
230
  def __init__(self):
231
231
  r"""
232
+ :param _NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
233
+ :type NoRefuse: bool
232
234
  :param _HideOneKeySign: 是否隐藏一键签署 默认false-不隐藏true-隐藏
233
235
  :type HideOneKeySign: bool
234
236
  :param _FillType: 签署人信息补充类型,默认无需补充。
@@ -246,10 +248,19 @@ class ApproverOption(AbstractModel):
246
248
  </ul>
247
249
  :type FlowReadLimit: str
248
250
  """
251
+ self._NoRefuse = None
249
252
  self._HideOneKeySign = None
250
253
  self._FillType = None
251
254
  self._FlowReadLimit = None
252
255
 
256
+ @property
257
+ def NoRefuse(self):
258
+ return self._NoRefuse
259
+
260
+ @NoRefuse.setter
261
+ def NoRefuse(self, NoRefuse):
262
+ self._NoRefuse = NoRefuse
263
+
253
264
  @property
254
265
  def HideOneKeySign(self):
255
266
  return self._HideOneKeySign
@@ -276,6 +287,7 @@ class ApproverOption(AbstractModel):
276
287
 
277
288
 
278
289
  def _deserialize(self, params):
290
+ self._NoRefuse = params.get("NoRefuse")
279
291
  self._HideOneKeySign = params.get("HideOneKeySign")
280
292
  self._FillType = params.get("FillType")
281
293
  self._FlowReadLimit = params.get("FlowReadLimit")
@@ -827,25 +839,34 @@ class ChannelBatchCancelFlowsRequest(AbstractModel):
827
839
 
828
840
  def __init__(self):
829
841
  r"""
830
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
842
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
843
+
844
+ 此接口下面信息必填。
845
+ <ul>
846
+ <li>渠道应用标识: Agent.AppId</li>
847
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
848
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
849
+ </ul>
850
+ 第三方平台子客企业和员工必须已经经过实名认证
831
851
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
832
- :param _FlowIds: 签署流程Id数组,最多100个,超过100不处理
852
+ :param _FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
833
853
  :type FlowIds: list of str
834
- :param _CancelMessage: 撤销理由,不超过200个字符
854
+ :param _CancelMessage: 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
855
+
856
+ 备注:`如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"`
835
857
  :type CancelMessage: str
836
- :param _CancelMessageFormat: 撤销理由自定义格式,支持以下格式
837
- <ul><li>0 : 默认值</li>
838
- <li>1 : 只保留身份信息</li>
839
- <li>2 : 保留身份信息+企业名称</li>
840
- <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
841
- 例如,假设合同的发起方是典子谦示例企业的经办人张三,撤销理由是"合同内容错误,需要修正",合同撤销后,各签署方看到的撤销理由是会是
842
-
843
- 0: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同
844
- 1: 发起方以"合同内容错误,需要修正"的理由撤销当前合同
845
- 2: 发起方-典子谦示例企业以"合同内容错误,需要修正"的理由撤销当前合同
846
- 3: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同</br>
847
-
848
- 备注:`如果不传递撤销理由,那么默认撤销理由是 "自动撤销(通过接口实现)"`
858
+ :param _CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
859
+
860
+ **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
861
+ **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
862
+ **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
863
+ **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
864
+
865
+ 注: `CancelMessage为撤销当前合同的理由`
866
+
867
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
868
+
869
+
849
870
  :type CancelMessageFormat: int
850
871
  :param _Operator: 暂未开放
851
872
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -928,7 +949,7 @@ class ChannelBatchCancelFlowsResponse(AbstractModel):
928
949
 
929
950
  def __init__(self):
930
951
  r"""
931
- :param _FailMessages: 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为“”,失败则对应失败消息
952
+ :param _FailMessages: 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
932
953
  :type FailMessages: list of str
933
954
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
934
955
  :type RequestId: str
@@ -1293,9 +1314,17 @@ class ChannelCreateBatchCancelFlowUrlRequest(AbstractModel):
1293
1314
 
1294
1315
  def __init__(self):
1295
1316
  r"""
1296
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1317
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1318
+
1319
+ 此接口下面信息必填。
1320
+ <ul>
1321
+ <li>渠道应用标识: Agent.AppId</li>
1322
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1323
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1324
+ </ul>
1325
+ 第三方平台子客企业和员工必须已经经过实名认证
1297
1326
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1298
- :param _FlowIds: 签署流程Id数组
1327
+ :param _FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
1299
1328
  :type FlowIds: list of str
1300
1329
  :param _Operator: 暂未开放
1301
1330
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -1358,11 +1387,13 @@ class ChannelCreateBatchCancelFlowUrlResponse(AbstractModel):
1358
1387
 
1359
1388
  def __init__(self):
1360
1389
  r"""
1361
- :param _BatchCancelFlowUrl: 批量撤销url
1390
+ :param _BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
1362
1391
  :type BatchCancelFlowUrl: str
1363
- :param _FailMessages: 签署流程批量撤销失败原因
1392
+ :param _FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
1364
1393
  :type FailMessages: list of str
1365
- :param _UrlExpireOn: 签署撤销url过期时间-年月日-时分秒
1394
+ :param _UrlExpireOn: 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
1395
+
1396
+
1366
1397
  :type UrlExpireOn: str
1367
1398
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1368
1399
  :type RequestId: str
@@ -1412,6 +1443,157 @@ class ChannelCreateBatchCancelFlowUrlResponse(AbstractModel):
1412
1443
  self._RequestId = params.get("RequestId")
1413
1444
 
1414
1445
 
1446
+ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
1447
+ """ChannelCreateBatchQuickSignUrl请求参数结构体
1448
+
1449
+ """
1450
+
1451
+ def __init__(self):
1452
+ r"""
1453
+ :param _FlowIds: 批量签署的合同流程ID数组。
1454
+ 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
1455
+ :type FlowIds: list of str
1456
+ :param _FlowApproverInfo: 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
1457
+ 注:
1458
+ `1. ApproverType目前只支持个人类型的签署人。`
1459
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
1460
+ `3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
1461
+ :type FlowApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
1462
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1463
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1464
+ :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
1465
+ :type JumpUrl: str
1466
+ :param _SignatureTypes: 指定批量签署合同的签名类型,可传递以下值:
1467
+ <ul><li>**0**:手写签名(默认)</li>
1468
+ <li>**1**:OCR楷体</li></ul>
1469
+ 注:
1470
+ <ul><li>默认情况下,签名类型为手写签名</li>
1471
+ <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
1472
+ :type SignatureTypes: list of int
1473
+ :param _ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值:
1474
+ <ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
1475
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
1476
+ 注:
1477
+ <ul><li>默认情况下,认证校验方式为人脸认证</li>
1478
+ <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
1479
+ :type ApproverSignTypes: list of int
1480
+ """
1481
+ self._FlowIds = None
1482
+ self._FlowApproverInfo = None
1483
+ self._Agent = None
1484
+ self._JumpUrl = None
1485
+ self._SignatureTypes = None
1486
+ self._ApproverSignTypes = None
1487
+
1488
+ @property
1489
+ def FlowIds(self):
1490
+ return self._FlowIds
1491
+
1492
+ @FlowIds.setter
1493
+ def FlowIds(self, FlowIds):
1494
+ self._FlowIds = FlowIds
1495
+
1496
+ @property
1497
+ def FlowApproverInfo(self):
1498
+ return self._FlowApproverInfo
1499
+
1500
+ @FlowApproverInfo.setter
1501
+ def FlowApproverInfo(self, FlowApproverInfo):
1502
+ self._FlowApproverInfo = FlowApproverInfo
1503
+
1504
+ @property
1505
+ def Agent(self):
1506
+ return self._Agent
1507
+
1508
+ @Agent.setter
1509
+ def Agent(self, Agent):
1510
+ self._Agent = Agent
1511
+
1512
+ @property
1513
+ def JumpUrl(self):
1514
+ return self._JumpUrl
1515
+
1516
+ @JumpUrl.setter
1517
+ def JumpUrl(self, JumpUrl):
1518
+ self._JumpUrl = JumpUrl
1519
+
1520
+ @property
1521
+ def SignatureTypes(self):
1522
+ return self._SignatureTypes
1523
+
1524
+ @SignatureTypes.setter
1525
+ def SignatureTypes(self, SignatureTypes):
1526
+ self._SignatureTypes = SignatureTypes
1527
+
1528
+ @property
1529
+ def ApproverSignTypes(self):
1530
+ return self._ApproverSignTypes
1531
+
1532
+ @ApproverSignTypes.setter
1533
+ def ApproverSignTypes(self, ApproverSignTypes):
1534
+ self._ApproverSignTypes = ApproverSignTypes
1535
+
1536
+
1537
+ def _deserialize(self, params):
1538
+ self._FlowIds = params.get("FlowIds")
1539
+ if params.get("FlowApproverInfo") is not None:
1540
+ self._FlowApproverInfo = FlowApproverInfo()
1541
+ self._FlowApproverInfo._deserialize(params.get("FlowApproverInfo"))
1542
+ if params.get("Agent") is not None:
1543
+ self._Agent = Agent()
1544
+ self._Agent._deserialize(params.get("Agent"))
1545
+ self._JumpUrl = params.get("JumpUrl")
1546
+ self._SignatureTypes = params.get("SignatureTypes")
1547
+ self._ApproverSignTypes = params.get("ApproverSignTypes")
1548
+ memeber_set = set(params.keys())
1549
+ for name, value in vars(self).items():
1550
+ property_name = name[1:]
1551
+ if property_name in memeber_set:
1552
+ memeber_set.remove(property_name)
1553
+ if len(memeber_set) > 0:
1554
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
1555
+
1556
+
1557
+
1558
+ class ChannelCreateBatchQuickSignUrlResponse(AbstractModel):
1559
+ """ChannelCreateBatchQuickSignUrl返回参数结构体
1560
+
1561
+ """
1562
+
1563
+ def __init__(self):
1564
+ r"""
1565
+ :param _FlowApproverUrlInfo: 签署人签署链接信息
1566
+ :type FlowApproverUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverUrlInfo`
1567
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1568
+ :type RequestId: str
1569
+ """
1570
+ self._FlowApproverUrlInfo = None
1571
+ self._RequestId = None
1572
+
1573
+ @property
1574
+ def FlowApproverUrlInfo(self):
1575
+ return self._FlowApproverUrlInfo
1576
+
1577
+ @FlowApproverUrlInfo.setter
1578
+ def FlowApproverUrlInfo(self, FlowApproverUrlInfo):
1579
+ self._FlowApproverUrlInfo = FlowApproverUrlInfo
1580
+
1581
+ @property
1582
+ def RequestId(self):
1583
+ return self._RequestId
1584
+
1585
+ @RequestId.setter
1586
+ def RequestId(self, RequestId):
1587
+ self._RequestId = RequestId
1588
+
1589
+
1590
+ def _deserialize(self, params):
1591
+ if params.get("FlowApproverUrlInfo") is not None:
1592
+ self._FlowApproverUrlInfo = FlowApproverUrlInfo()
1593
+ self._FlowApproverUrlInfo._deserialize(params.get("FlowApproverUrlInfo"))
1594
+ self._RequestId = params.get("RequestId")
1595
+
1596
+
1415
1597
  class ChannelCreateBatchSignUrlRequest(AbstractModel):
1416
1598
  """ChannelCreateBatchSignUrl请求参数结构体
1417
1599
 
@@ -1754,13 +1936,35 @@ class ChannelCreateConvertTaskApiRequest(AbstractModel):
1754
1936
 
1755
1937
  def __init__(self):
1756
1938
  r"""
1757
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1939
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1940
+
1941
+ 此接口下面信息必填。
1942
+ <ul>
1943
+ <li>渠道应用标识: Agent.AppId</li>
1944
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1945
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1946
+ </ul>
1947
+ 第三方平台子客企业和员工必须已经经过实名认证
1758
1948
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1759
- :param _ResourceType: 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
1949
+ :param _ResourceType: 需要进行转换的资源文件类型
1950
+ 支持的文件类型如下:
1951
+ <ul><li>doc</li>
1952
+ <li>docx</li>
1953
+ <li>xls</li>
1954
+ <li>xlsx</li>
1955
+ <li>jpg</li>
1956
+ <li>jpeg</li>
1957
+ <li>png</li>
1958
+ <li>bmp</li>
1959
+ <li>txt</li></ul>
1760
1960
  :type ResourceType: str
1761
- :param _ResourceName: 资源名称,长度限制为256字符
1961
+ :param _ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
1962
+
1963
+ 注: `资源名称长度限制为256个字符`
1762
1964
  :type ResourceName: str
1763
- :param _ResourceId: 文件Id,通过UploadFiles获取
1965
+ :param _ResourceId: 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
1966
+
1967
+ 注: `目前,此接口仅支持单个文件进行转换。`
1764
1968
  :type ResourceId: str
1765
1969
  :param _Operator: 调用方用户信息,不用传
1766
1970
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -1861,7 +2065,7 @@ class ChannelCreateConvertTaskApiResponse(AbstractModel):
1861
2065
 
1862
2066
  def __init__(self):
1863
2067
  r"""
1864
- :param _TaskId: 任务id
2068
+ :param _TaskId: 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
1865
2069
  :type TaskId: str
1866
2070
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1867
2071
  :type RequestId: str
@@ -4136,13 +4340,28 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4136
4340
 
4137
4341
  def __init__(self):
4138
4342
  r"""
4139
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
4343
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4344
+
4345
+ 此接口下面信息必填。
4346
+ <ul>
4347
+ <li>渠道应用标识: Agent.AppId</li>
4348
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4349
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4350
+ </ul>
4351
+ 第三方平台子客企业和员工必须已经经过实名认证
4140
4352
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4141
- :param _NeedRelievedFlowId: 待解除的流程编号(即原流程的编号)
4353
+ :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
4142
4354
  :type NeedRelievedFlowId: str
4143
- :param _ReliveInfo: 解除协议内容
4355
+ :param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
4144
4356
  :type ReliveInfo: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
4145
- :param _ReleasedApprovers: 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,已转发的签署人不包含在内,解除协议的签署人数量不能多于原流程的签署人数量
4357
+ :param _ReleasedApprovers: 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
4358
+ 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
4359
+
4360
+ 注意:
4361
+ <ul>
4362
+ <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
4363
+ <li>可以不指定替换签署人, 使用原流程的签署人</li>
4364
+ </ul>
4146
4365
  :type ReleasedApprovers: list of ReleasedApprover
4147
4366
  :param _CallbackUrl: 签署完回调url,最大长度1000个字符
4148
4367
  :type CallbackUrl: str
@@ -4150,8 +4369,15 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4150
4369
  :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
4151
4370
  :param _Operator: 暂未开放
4152
4371
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
4153
- :param _Deadline: 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
4372
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
4373
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
4154
4374
  :type Deadline: int
4375
+ :param _UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
4376
+
4377
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
4378
+
4379
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
4380
+ :type UserData: str
4155
4381
  """
4156
4382
  self._Agent = None
4157
4383
  self._NeedRelievedFlowId = None
@@ -4161,6 +4387,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4161
4387
  self._Organization = None
4162
4388
  self._Operator = None
4163
4389
  self._Deadline = None
4390
+ self._UserData = None
4164
4391
 
4165
4392
  @property
4166
4393
  def Agent(self):
@@ -4196,10 +4423,14 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4196
4423
 
4197
4424
  @property
4198
4425
  def CallbackUrl(self):
4426
+ warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
4427
+
4199
4428
  return self._CallbackUrl
4200
4429
 
4201
4430
  @CallbackUrl.setter
4202
4431
  def CallbackUrl(self, CallbackUrl):
4432
+ warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
4433
+
4203
4434
  self._CallbackUrl = CallbackUrl
4204
4435
 
4205
4436
  @property
@@ -4234,6 +4465,14 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4234
4465
  def Deadline(self, Deadline):
4235
4466
  self._Deadline = Deadline
4236
4467
 
4468
+ @property
4469
+ def UserData(self):
4470
+ return self._UserData
4471
+
4472
+ @UserData.setter
4473
+ def UserData(self, UserData):
4474
+ self._UserData = UserData
4475
+
4237
4476
 
4238
4477
  def _deserialize(self, params):
4239
4478
  if params.get("Agent") is not None:
@@ -4257,6 +4496,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4257
4496
  self._Operator = UserInfo()
4258
4497
  self._Operator._deserialize(params.get("Operator"))
4259
4498
  self._Deadline = params.get("Deadline")
4499
+ self._UserData = params.get("UserData")
4260
4500
  memeber_set = set(params.keys())
4261
4501
  for name, value in vars(self).items():
4262
4502
  property_name = name[1:]
@@ -4558,22 +4798,29 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
4558
4798
 
4559
4799
  def __init__(self):
4560
4800
  r"""
4561
- :param _Agent: 渠道应用相关信息
4801
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4562
4802
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4563
- :param _SceneKey: 自动签场景:
4564
- E_PRESCRIPTION_AUTO_SIGN 电子处方
4803
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
4804
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4805
+
4806
+ 注: `现在仅支持电子处方场景`
4565
4807
  :type SceneKey: str
4566
- :param _Operator: 操作人信息
4808
+ :param _Operator: 执行本接口操作的员工信息。
4809
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4567
4810
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
4568
- :param _AutoSignConfig: 自动签开通,签署相关配置
4811
+ :param _AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
4569
4812
  :type AutoSignConfig: :class:`tencentcloud.essbasic.v20210526.models.AutoSignConfig`
4570
- :param _UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
4813
+ :param _UrlType: 生成的链接类型:
4814
+ <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
4815
+ <li> **H5SIGN** : 生成H5端开通链接</li></ul>
4571
4816
  :type UrlType: str
4572
- :param _NotifyType: 通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。
4817
+ :param _NotifyType: 是否通知开通方,通知类型:
4818
+ <ul><li>默认不设置为不通知开通方</li>
4819
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
4573
4820
  :type NotifyType: str
4574
- :param _NotifyAddress: 若上方填写为 SMS,则此处为手机号
4821
+ :param _NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
4575
4822
  :type NotifyAddress: str
4576
- :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。
4823
+ :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
4577
4824
  :type ExpiredTime: int
4578
4825
  """
4579
4826
  self._Agent = None
@@ -4682,17 +4929,27 @@ class ChannelCreateUserAutoSignEnableUrlResponse(AbstractModel):
4682
4929
 
4683
4930
  def __init__(self):
4684
4931
  r"""
4685
- :param _Url: 跳转短链
4932
+ :param _Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
4686
4933
  :type Url: str
4687
- :param _AppId: 小程序AppId
4934
+ :param _AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
4935
+
4936
+ 注: `如果获取的是H5链接, 则不会返回此值`
4688
4937
  :type AppId: str
4689
- :param _AppOriginalId: 小程序 原始 Id
4938
+ :param _AppOriginalId: 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
4939
+
4940
+ 注: `如果获取的是H5链接, 则不会返回此值`
4690
4941
  :type AppOriginalId: str
4691
- :param _Path: 跳转路径
4942
+ :param _Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
4943
+
4944
+ 注: `如果获取的是H5链接, 则不会返回此值`
4692
4945
  :type Path: str
4693
- :param _QrCode: base64格式跳转二维码
4946
+ :param _QrCode: base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
4947
+
4948
+ 注: `如果获取的是H5链接, 则不会返回此二维码图片`
4694
4949
  :type QrCode: str
4695
- :param _UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
4950
+ :param _UrlType: 返回的链接类型
4951
+ <ul><li> 空: 默认小程序端链接</li>
4952
+ <li> **H5SIGN** : h5端链接</li></ul>
4696
4953
  :type UrlType: str
4697
4954
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4698
4955
  :type RequestId: str
@@ -6360,9 +6617,17 @@ class ChannelGetTaskResultApiRequest(AbstractModel):
6360
6617
 
6361
6618
  def __init__(self):
6362
6619
  r"""
6363
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
6620
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6621
+
6622
+ 此接口下面信息必填。
6623
+ <ul>
6624
+ <li>渠道应用标识: Agent.AppId</li>
6625
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6626
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6627
+ </ul>
6628
+ 第三方平台子客企业和员工必须已经经过实名认证
6364
6629
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6365
- :param _TaskId: 任务Id,通过ChannelCreateConvertTaskApi接口获得
6630
+ :param _TaskId: 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
6366
6631
  :type TaskId: str
6367
6632
  :param _Operator: 操作者的信息,不用传
6368
6633
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -6446,22 +6711,22 @@ class ChannelGetTaskResultApiResponse(AbstractModel):
6446
6711
  :param _TaskId: 任务Id
6447
6712
  :type TaskId: str
6448
6713
  :param _TaskStatus: 任务状态,需要关注的状态
6449
- 0 :NeedTranform - 任务已提交
6450
- 4 :Processing - 文档转换中
6451
- 8 :TaskEnd - 任务处理完成
6452
- -2 :DownloadFailed - 下载失败
6453
- -6 :ProcessFailed - 转换失败
6454
- -13:ProcessTimeout - 转换文件超时
6714
+ <ul><li>**0** :NeedTranform - 任务已提交</li>
6715
+ <li>**4** :Processing - 文档转换中</li>
6716
+ <li>**8** :TaskEnd - 任务处理完成</li>
6717
+ <li>**-2** :DownloadFailed - 下载失败</li>
6718
+ <li>**-6** :ProcessFailed - 转换失败</li>
6719
+ <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
6455
6720
  :type TaskStatus: int
6456
6721
  :param _TaskMessage: 状态描述,需要关注的状态
6457
- NeedTranform - 任务已提交
6458
- Processing - 文档转换中
6459
- TaskEnd - 任务处理完成
6460
- DownloadFailed - 下载失败
6461
- ProcessFailed - 转换失败
6462
- ProcessTimeout - 转换文件超时
6722
+ <ul><li> **NeedTranform** : 任务已提交</li>
6723
+ <li> **Processing** : 文档转换中</li>
6724
+ <li> **TaskEnd** : 任务处理完成</li>
6725
+ <li> **DownloadFailed** : 下载失败</li>
6726
+ <li> **ProcessFailed** : 转换失败</li>
6727
+ <li> **ProcessTimeout** : 转换文件超时</li></ul>
6463
6728
  :type TaskMessage: str
6464
- :param _ResourceId: 资源Id,也是FileId,用于文件发起使用
6729
+ :param _ResourceId: 资源Id,也是FileId,用于文件发起时使用
6465
6730
  :type ResourceId: str
6466
6731
  :param _PreviewUrl: 预览文件Url,有效期30分钟
6467
6732
  当前字段返回为空,发起的时候,将ResourceId 放入发起即可
@@ -9778,49 +10043,83 @@ class DescribeTemplatesRequest(AbstractModel):
9778
10043
 
9779
10044
  def __init__(self):
9780
10045
  r"""
9781
- :param _Agent: 应用相关信息。
9782
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
10046
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
10047
+
10048
+ 此接口下面信息必填。
10049
+ <ul>
10050
+ <li>渠道应用标识: Agent.AppId</li>
10051
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
10052
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
10053
+ </ul>
10054
+ 第三方平台子客企业和员工必须已经经过实名认证
9783
10055
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9784
- :param _TemplateId: 模板唯一标识,查询单个模板时使用
10056
+ :param _TemplateId: 合同模板ID,为32位字符串。
10057
+
10058
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
9785
10059
  :type TemplateId: str
9786
- :param _ContentType: 查询内容:
9787
- 0-模板列表及详情(默认),
9788
- 1-仅模板列表
10060
+ :param _ContentType: 查询模版的内容
10061
+
10062
+ <ul><li>**0**:(默认)模板列表及详情</li>
10063
+ <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
9789
10064
  :type ContentType: int
9790
- :param _Limit: 指定每页多少条数据,如果不传默认为20,单页最大100。
10065
+ :param _TemplateIds: 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
10066
+
10067
+ 注意:
10068
+ 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
10069
+ 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
10070
+ 4. `若传递此参数,分页参数(Limit,Offset)无效`
10071
+
10072
+ :type TemplateIds: list of str
10073
+ :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用。
10074
+
10075
+ 注:`1.默认值为20,单页做大值为200。`
9791
10076
  :type Limit: int
9792
- :param _Offset: 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
10077
+ :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
10078
+
10079
+ 注:`1.offset从0开始,即第一页为0。`
10080
+ `2.默认从第一页返回。`
9793
10081
  :type Offset: int
9794
- :param _QueryAllComponents: 是否返回所有组件信息。
9795
- 默认false,只返回发起方控件;
9796
- true,返回所有签署方控件
9797
- :type QueryAllComponents: bool
9798
- :param _TemplateName: 模糊搜索模板名称,最大长度200
10082
+ :param _TemplateName: 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
9799
10083
  :type TemplateName: str
9800
- :param _WithPreviewUrl: 是否获取模板预览链接,
9801
- 默认false-不获取
9802
- true-获取
10084
+ :param _ChannelTemplateId: 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
10085
+ :type ChannelTemplateId: str
10086
+ :param _QueryAllComponents: 返回控件的范围, 是只返回发起方自己的还是所有参与方的
10087
+
10088
+ <ul><li>**false**:(默认)只返回发起方控件</li>
10089
+ <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
10090
+ :type QueryAllComponents: bool
10091
+ :param _WithPreviewUrl: 是否获取模板预览链接。
10092
+
10093
+ <ul><li>**false**:不获取(默认)</li>
10094
+ <li>**true**:获取</li></ul>
10095
+
10096
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
10097
+
10098
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
9803
10099
  :type WithPreviewUrl: bool
9804
10100
  :param _WithPdfUrl: 是否获取模板的PDF文件链接。
9805
- 默认false-不获取
9806
- true-获取
9807
- 请联系客户经理开白后使用。
10101
+
10102
+ <ul><li>**false**:不获取(默认)</li>
10103
+ <li>**true**:获取</li></ul>
10104
+
10105
+ 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
10106
+
10107
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
9808
10108
  :type WithPdfUrl: bool
9809
- :param _ChannelTemplateId: 对应第三方应用平台企业的模板ID
9810
- :type ChannelTemplateId: str
9811
10109
  :param _Operator: 操作者的信息
9812
10110
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
9813
10111
  """
9814
10112
  self._Agent = None
9815
10113
  self._TemplateId = None
9816
10114
  self._ContentType = None
10115
+ self._TemplateIds = None
9817
10116
  self._Limit = None
9818
10117
  self._Offset = None
9819
- self._QueryAllComponents = None
9820
10118
  self._TemplateName = None
10119
+ self._ChannelTemplateId = None
10120
+ self._QueryAllComponents = None
9821
10121
  self._WithPreviewUrl = None
9822
10122
  self._WithPdfUrl = None
9823
- self._ChannelTemplateId = None
9824
10123
  self._Operator = None
9825
10124
 
9826
10125
  @property
@@ -9847,6 +10146,14 @@ true-获取
9847
10146
  def ContentType(self, ContentType):
9848
10147
  self._ContentType = ContentType
9849
10148
 
10149
+ @property
10150
+ def TemplateIds(self):
10151
+ return self._TemplateIds
10152
+
10153
+ @TemplateIds.setter
10154
+ def TemplateIds(self, TemplateIds):
10155
+ self._TemplateIds = TemplateIds
10156
+
9850
10157
  @property
9851
10158
  def Limit(self):
9852
10159
  return self._Limit
@@ -9863,14 +10170,6 @@ true-获取
9863
10170
  def Offset(self, Offset):
9864
10171
  self._Offset = Offset
9865
10172
 
9866
- @property
9867
- def QueryAllComponents(self):
9868
- return self._QueryAllComponents
9869
-
9870
- @QueryAllComponents.setter
9871
- def QueryAllComponents(self, QueryAllComponents):
9872
- self._QueryAllComponents = QueryAllComponents
9873
-
9874
10173
  @property
9875
10174
  def TemplateName(self):
9876
10175
  return self._TemplateName
@@ -9879,6 +10178,22 @@ true-获取
9879
10178
  def TemplateName(self, TemplateName):
9880
10179
  self._TemplateName = TemplateName
9881
10180
 
10181
+ @property
10182
+ def ChannelTemplateId(self):
10183
+ return self._ChannelTemplateId
10184
+
10185
+ @ChannelTemplateId.setter
10186
+ def ChannelTemplateId(self, ChannelTemplateId):
10187
+ self._ChannelTemplateId = ChannelTemplateId
10188
+
10189
+ @property
10190
+ def QueryAllComponents(self):
10191
+ return self._QueryAllComponents
10192
+
10193
+ @QueryAllComponents.setter
10194
+ def QueryAllComponents(self, QueryAllComponents):
10195
+ self._QueryAllComponents = QueryAllComponents
10196
+
9882
10197
  @property
9883
10198
  def WithPreviewUrl(self):
9884
10199
  return self._WithPreviewUrl
@@ -9895,14 +10210,6 @@ true-获取
9895
10210
  def WithPdfUrl(self, WithPdfUrl):
9896
10211
  self._WithPdfUrl = WithPdfUrl
9897
10212
 
9898
- @property
9899
- def ChannelTemplateId(self):
9900
- return self._ChannelTemplateId
9901
-
9902
- @ChannelTemplateId.setter
9903
- def ChannelTemplateId(self, ChannelTemplateId):
9904
- self._ChannelTemplateId = ChannelTemplateId
9905
-
9906
10213
  @property
9907
10214
  def Operator(self):
9908
10215
  warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
@@ -9922,13 +10229,14 @@ true-获取
9922
10229
  self._Agent._deserialize(params.get("Agent"))
9923
10230
  self._TemplateId = params.get("TemplateId")
9924
10231
  self._ContentType = params.get("ContentType")
10232
+ self._TemplateIds = params.get("TemplateIds")
9925
10233
  self._Limit = params.get("Limit")
9926
10234
  self._Offset = params.get("Offset")
9927
- self._QueryAllComponents = params.get("QueryAllComponents")
9928
10235
  self._TemplateName = params.get("TemplateName")
10236
+ self._ChannelTemplateId = params.get("ChannelTemplateId")
10237
+ self._QueryAllComponents = params.get("QueryAllComponents")
9929
10238
  self._WithPreviewUrl = params.get("WithPreviewUrl")
9930
10239
  self._WithPdfUrl = params.get("WithPdfUrl")
9931
- self._ChannelTemplateId = params.get("ChannelTemplateId")
9932
10240
  if params.get("Operator") is not None:
9933
10241
  self._Operator = UserInfo()
9934
10242
  self._Operator._deserialize(params.get("Operator"))
@@ -9949,11 +10257,11 @@ class DescribeTemplatesResponse(AbstractModel):
9949
10257
 
9950
10258
  def __init__(self):
9951
10259
  r"""
9952
- :param _Templates: 模板列表
10260
+ :param _Templates: 模板详情列表数据
9953
10261
  :type Templates: list of TemplateInfo
9954
- :param _TotalCount: 查询到的总数
10262
+ :param _TotalCount: 查询到的模板总数
9955
10263
  :type TotalCount: int
9956
- :param _Limit: 每页多少条数据
10264
+ :param _Limit: 每页返回的数据条数
9957
10265
  :type Limit: int
9958
10266
  :param _Offset: 查询结果分页返回,此处指定第几页。页码从0开始,即首页为0。
9959
10267
  :type Offset: int
@@ -10989,9 +11297,13 @@ class FlowApproverInfo(AbstractModel):
10989
11297
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
10990
11298
  :param _ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
10991
11299
  :type ApproverNeedSignReview: bool
10992
- :param _ApproverVerifyTypes: 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
10993
- 查看合同的认证方式 Flow层级的优先于approver层级的
10994
- (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
11300
+ :param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
11301
+ <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
11302
+ <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
11303
+ </li></ul>
11304
+ 注:
11305
+ <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
11306
+ <li>此字段可传多个校验方式</li></ul>
10995
11307
  :type ApproverVerifyTypes: list of int
10996
11308
  :param _ApproverSignTypes: 签署人签署合同时的认证方式
10997
11309
  <ul><li> **1** :人脸认证</li>
@@ -11016,7 +11328,9 @@ class FlowApproverInfo(AbstractModel):
11016
11328
 
11017
11329
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
11018
11330
  :type AddSignComponentsLimits: list of ComponentLimit
11019
- :param _ApproverRoleName: 自定义签署人角色名,如收款人、开具人、见证人等
11331
+ :param _ApproverRoleName: 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
11332
+
11333
+ 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
11020
11334
  :type ApproverRoleName: str
11021
11335
  """
11022
11336
  self._Name = None
@@ -11938,36 +12252,68 @@ class FlowInfo(AbstractModel):
11938
12252
 
11939
12253
  def __init__(self):
11940
12254
  r"""
11941
- :param _FlowName: 合同名字,最大长度200个字符
12255
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
11942
12256
  :type FlowName: str
11943
- :param _Deadline: 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
12257
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
12258
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
12259
+ 示例值:1604912664
11944
12260
  :type Deadline: int
11945
- :param _TemplateId: 模板ID
12261
+ :param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
12262
+
12263
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
11946
12264
  :type TemplateId: str
11947
12265
  :param _FlowApprovers: 多个签署人信息,最大支持50个签署方
11948
12266
  :type FlowApprovers: list of FlowApproverInfo
11949
12267
  :param _FormFields: 表单K-V对列表
11950
12268
  :type FormFields: list of FormField
11951
- :param _CallbackUrl: 回调地址,最大长度1000个字符
12269
+ :param _CallbackUrl: 合同状态变动结的通知回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性,最大长度1000个字符。
12270
+
12271
+ 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
12272
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块
11952
12273
  :type CallbackUrl: str
11953
- :param _FlowType: 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
12274
+ :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
11954
12275
  :type FlowType: str
11955
- :param _FlowDescription: 合同描述,最大长度1000个字符
12276
+ :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
11956
12277
  :type FlowDescription: str
11957
- :param _CustomerData: 第三方应用平台的业务信息,最大长度1000个字符。
12278
+ :param _CustomerData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
12279
+
12280
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
11958
12281
  :type CustomerData: str
11959
- :param _CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
12282
+ :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
12283
+ <ul><li>{合同名称} </li>
12284
+ <li>{发起方企业} </li>
12285
+ <li>{发起方姓名} </li>
12286
+ <li>{签署方N企业}</li>
12287
+ <li>{签署方N姓名}</li></ul>
12288
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
12289
+
12290
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
12291
+
12292
+ 合同名称:租房合同
12293
+ 发起方:腾讯公司(张三)
12294
+ 签署方:李四
12295
+
12296
+
11960
12297
  :type CustomShowMap: str
11961
- :param _CcInfos: 被抄送人的信息列表,抄送功能暂不开放
11962
- :type CcInfos: list of CcInfo
11963
- :param _NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。
11964
- 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
12298
+ :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
11965
12299
 
11966
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
12300
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
12301
+ :type CcInfos: list of CcInfo
12302
+ :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
12303
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
12304
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
12305
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
12306
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
12307
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
12308
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
11967
12309
  :type NeedSignReview: bool
11968
- :param _CcNotifyType: 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
12310
+ :param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
12311
+ <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
12312
+ <li> **1** : 签署完成后通知对方来查看合同</li></ul>
11969
12313
  :type CcNotifyType: int
11970
- :param _AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
12314
+ :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
12315
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
12316
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
11971
12317
  :type AutoSignScene: str
11972
12318
  """
11973
12319
  self._FlowName = None
@@ -13863,22 +14209,22 @@ class ProxyOrganizationOperator(AbstractModel):
13863
14209
 
13864
14210
 
13865
14211
  class Recipient(AbstractModel):
13866
- """流程中参与方的信息结构
14212
+ """流程中签署方和填写方(如果有填写控件存证时)的信息
13867
14213
 
13868
14214
  """
13869
14215
 
13870
14216
  def __init__(self):
13871
14217
  r"""
13872
- :param _RecipientId: 签署人唯一标识,在通过模板发起合同的时候对应签署方ID
14218
+ :param _RecipientId: 合同参与方的角色ID
13873
14219
  :type RecipientId: str
13874
- :param _RecipientType: 参与者类型,默认为空。
13875
- ENTERPRISE-企业;
13876
- INDIVIDUAL-个人;
13877
- PROMOTER-发起方
14220
+ :param _RecipientType: 参与者类型, 可以选择的类型如下:
14221
+ <ul><li> **ENTERPRISE** :此角色为企业参与方</li>
14222
+ <li> **INDIVIDUAL** :此角色为个人参与方</li>
14223
+ <li> **PROMOTER** :此角色是发起方</li></ul>
13878
14224
  :type RecipientType: str
13879
- :param _Description: 描述信息
14225
+ :param _Description: 合同参与方的角色描述,长度不能超过100,只能由中文、字母、数字和下划线组成。
13880
14226
  :type Description: str
13881
- :param _RoleName: 角色名称
14227
+ :param _RoleName: 合同参与方的角色名字,长度不能超过20,只能由中文、字母、数字和下划线组成。
13882
14228
  :type RoleName: str
13883
14229
  :param _RequireValidation: 是否需要校验,
13884
14230
  true-是,