tencentcloud-sdk-python-essbasic 3.0.1165__tar.gz → 3.0.1183__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/setup.py +1 -1
  3. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20210526/essbasic_client.py +91 -14
  5. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20210526/models.py +372 -25
  6. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
  7. tencentcloud-sdk-python-essbasic-3.0.1183/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  8. tencentcloud-sdk-python-essbasic-3.0.1165/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  9. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/README.rst +0 -0
  10. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/setup.cfg +0 -0
  11. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/__init__.py +0 -0
  12. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  13. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  15. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-essbasic-3.0.1165 → tencentcloud-sdk-python-essbasic-3.0.1183}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1165
3
+ Version: 3.0.1183
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-essbasic',
11
- install_requires=["tencentcloud-sdk-python-common==3.0.1165"],
11
+ install_requires=["tencentcloud-sdk-python-common==3.0.1183"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Essbasic SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1165'
17
+ __version__ = '3.0.1183'
@@ -396,6 +396,10 @@ class EssbasicClient(AbstractClient):
396
396
 
397
397
  `4. 静默(自动)签署不支持合同签署方存在填写功能`
398
398
 
399
+ <font color="red">相关视频指引</font> <br>
400
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
401
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a><br>
402
+
399
403
  :param request: Request instance for ChannelCreateFlowByFiles.
400
404
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowByFilesRequest`
401
405
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowByFilesResponse`
@@ -663,11 +667,10 @@ class EssbasicClient(AbstractClient):
663
667
  """该接口用于发起合同后,生成用户的签署链接 <br/>
664
668
 
665
669
  **注意**
666
- 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
667
- 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
668
- 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
669
- 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
670
- 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
670
+ 1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
671
+ 2. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。配置方式请参考:<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
672
+ 如需跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
673
+ 3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
671
674
 
672
675
  :param request: Request instance for ChannelCreateFlowSignUrl.
673
676
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
@@ -1215,11 +1218,10 @@ class EssbasicClient(AbstractClient):
1215
1218
 
1216
1219
 
1217
1220
  def ChannelDescribeOrganizationSeals(self, request):
1218
- """此接口(ChannelDescribeOrganizationSeals)查询子客企业电子印章。<br />
1219
- 注:
1220
- 1. `查询子客企业电子印章,需要操作者具有管理印章权限`
1221
- 2. `客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理`
1222
- 3. `此接口只能查询启用的印章`
1221
+ """此接口查询子企业电子印章。<br />
1222
+
1223
+ 注:
1224
+ 1. 此操作要求操作者具备<b>印章查询权限</b>(若调用者尚无此权限,请联系超级管理员前往Web控制台【组织管理】->【角色管理】添加相应权限)。
1223
1225
 
1224
1226
  :param request: Request instance for ChannelDescribeOrganizationSeals.
1225
1227
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeOrganizationSealsRequest`
@@ -1637,7 +1639,6 @@ class EssbasicClient(AbstractClient):
1637
1639
  <th>子客企业状态</th>
1638
1640
  <th>子客企业员工状态</th>
1639
1641
  <th>点击链接进入的流程</th>
1640
- <th>视频样例</th>
1641
1642
  </tr>
1642
1643
  </thead>
1643
1644
  <tbody>
@@ -1645,19 +1646,16 @@ class EssbasicClient(AbstractClient):
1645
1646
  <td>企业未激活</td>
1646
1647
  <td>员工未认证</td>
1647
1648
  <td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
1648
- <td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
1649
1649
  </tr>
1650
1650
  <tr>
1651
1651
  <td>企业已激活</td>
1652
1652
  <td>员工未认证</td>
1653
1653
  <td>进入员认证并加入企业流程</td>
1654
- <td>-</td>
1655
1654
  </tr>
1656
1655
  <tr>
1657
1656
  <td>企业已激活</td>
1658
1657
  <td>员工已认证</td>
1659
1658
  <td>进入子客企业Web控制台</td>
1660
- <td>-</td>
1661
1659
  </tr>
1662
1660
  </tbody>
1663
1661
  </table>
@@ -1669,6 +1667,10 @@ class EssbasicClient(AbstractClient):
1669
1667
  系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
1670
1668
  ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
1671
1669
 
1670
+
1671
+ <font color="red">相关视频指引</font> <br>
1672
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4" target="_blank">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>
1673
+
1672
1674
  :param request: Request instance for CreateConsoleLoginUrl.
1673
1675
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlRequest`
1674
1676
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlResponse`
@@ -1689,6 +1691,39 @@ class EssbasicClient(AbstractClient):
1689
1691
  raise TencentCloudSDKException(type(e).__name__, str(e))
1690
1692
 
1691
1693
 
1694
+ def CreateFlowBlockchainEvidenceUrl(self, request):
1695
+ """获取区块链存证证书查看链接/二维码接口
1696
+
1697
+ 适用场景:企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码,以供他人扫码打开腾讯电子签小程序查看。
1698
+
1699
+ [点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
1700
+
1701
+ 注:
1702
+ <ul><li>1. 二维码下载链接过期时间为5分钟,请尽快下载保存。二维码/短链的过期时间为<font color="red">7天</font>,超过有效期则不可用。</li>
1703
+ <li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成证书查看二维码/短链。</li>
1704
+ <li>3. 调用接口时,需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>
1705
+ <li>4. 通过扫码或者点击链接,用户无需登录或者鉴权即可查看对应合同的区块链存证证书,请妥善保管好二维码或链接。</li></ul>
1706
+
1707
+ :param request: Request instance for CreateFlowBlockchainEvidenceUrl.
1708
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowBlockchainEvidenceUrlRequest`
1709
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowBlockchainEvidenceUrlResponse`
1710
+
1711
+ """
1712
+ try:
1713
+ params = request._serialize()
1714
+ headers = request.headers
1715
+ body = self.call("CreateFlowBlockchainEvidenceUrl", params, headers=headers)
1716
+ response = json.loads(body)
1717
+ model = models.CreateFlowBlockchainEvidenceUrlResponse()
1718
+ model._deserialize(response["Response"])
1719
+ return model
1720
+ except Exception as e:
1721
+ if isinstance(e, TencentCloudSDKException):
1722
+ raise
1723
+ else:
1724
+ raise TencentCloudSDKException(type(e).__name__, str(e))
1725
+
1726
+
1692
1727
  def CreateFlowGroupSignReview(self, request):
1693
1728
  """1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时,若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
1694
1729
  - [FlowInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowinfo)
@@ -1778,6 +1813,11 @@ class EssbasicClient(AbstractClient):
1778
1813
 
1779
1814
  5. <font color="red">在下一步创建签署链接前,建议等待DocumentFill </font> <a href="https://qian.tencent.com/developers/partner/callback_types_file_resources">PDF合成完成的回调</a>或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
1780
1815
 
1816
+
1817
+ <font color="red">相关视频指引</font> <br>
1818
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
1819
+ 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateFlowsByTemplates.mp4" target="_blank">【用模板创建签署流程】编写示例视频教程</a><br>
1820
+
1781
1821
  :param request: Request instance for CreateFlowsByTemplates.
1782
1822
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesRequest`
1783
1823
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesResponse`
@@ -1798,6 +1838,37 @@ class EssbasicClient(AbstractClient):
1798
1838
  raise TencentCloudSDKException(type(e).__name__, str(e))
1799
1839
 
1800
1840
 
1841
+ def CreateLegalSealQrCode(self, request):
1842
+ """该接口用于获取创建法人章的二维码,需要通过微信扫描。扫描后将跳转到腾讯电子签署,进入到创建法人章的流程。
1843
+
1844
+ **注意**
1845
+ 1. 该二维码**有效期为7天**,过期后将失效,可重新创建 。
1846
+ 2. 每个公司**只能有1个法人章**,无法重复创建或者创建多个
1847
+
1848
+ 法人章的样式可以参考下图索引(也可以自己上传法人印章图片):
1849
+
1850
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/36a0a090750c45bb5cac5047ac461b2c.png)
1851
+
1852
+ :param request: Request instance for CreateLegalSealQrCode.
1853
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateLegalSealQrCodeRequest`
1854
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateLegalSealQrCodeResponse`
1855
+
1856
+ """
1857
+ try:
1858
+ params = request._serialize()
1859
+ headers = request.headers
1860
+ body = self.call("CreateLegalSealQrCode", params, headers=headers)
1861
+ response = json.loads(body)
1862
+ model = models.CreateLegalSealQrCodeResponse()
1863
+ model._deserialize(response["Response"])
1864
+ return model
1865
+ except Exception as e:
1866
+ if isinstance(e, TencentCloudSDKException):
1867
+ raise
1868
+ else:
1869
+ raise TencentCloudSDKException(type(e).__name__, str(e))
1870
+
1871
+
1801
1872
  def CreatePartnerAutoSignAuthUrl(self, request):
1802
1873
  """创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。
1803
1874
  该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
@@ -2186,6 +2257,9 @@ class EssbasicClient(AbstractClient):
2186
2257
  >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
2187
2258
  >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
2188
2259
 
2260
+ <font color="red">相关视频指引</font> <br>
2261
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
2262
+
2189
2263
  :param request: Request instance for DescribeTemplates.
2190
2264
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeTemplatesRequest`
2191
2265
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeTemplatesResponse`
@@ -2487,6 +2561,9 @@ class EssbasicClient(AbstractClient):
2487
2561
  httpProfile.setEndpoint("file.test.ess.tencent.cn");
2488
2562
  ```
2489
2563
 
2564
+ <font color="red">相关视频指引</font> <br>
2565
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
2566
+
2490
2567
  :param request: Request instance for UploadFiles.
2491
2568
  :type request: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesRequest`
2492
2569
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesResponse`
@@ -2635,6 +2635,8 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2635
2635
  </li>
2636
2636
  </ul>
2637
2637
  :type UserData: str
2638
+ :param _Option: 个性化参数,用于控制页面展示内容
2639
+ :type Option: :class:`tencentcloud.essbasic.v20210526.models.EmbedUrlOption`
2638
2640
  """
2639
2641
  self._Agent = None
2640
2642
  self._EmbedType = None
@@ -2642,6 +2644,7 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2642
2644
  self._HiddenComponents = None
2643
2645
  self._Operator = None
2644
2646
  self._UserData = None
2647
+ self._Option = None
2645
2648
 
2646
2649
  @property
2647
2650
  def Agent(self):
@@ -2695,6 +2698,14 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2695
2698
  def UserData(self, UserData):
2696
2699
  self._UserData = UserData
2697
2700
 
2701
+ @property
2702
+ def Option(self):
2703
+ return self._Option
2704
+
2705
+ @Option.setter
2706
+ def Option(self, Option):
2707
+ self._Option = Option
2708
+
2698
2709
 
2699
2710
  def _deserialize(self, params):
2700
2711
  if params.get("Agent") is not None:
@@ -2707,6 +2718,9 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
2707
2718
  self._Operator = UserInfo()
2708
2719
  self._Operator._deserialize(params.get("Operator"))
2709
2720
  self._UserData = params.get("UserData")
2721
+ if params.get("Option") is not None:
2722
+ self._Option = EmbedUrlOption()
2723
+ self._Option._deserialize(params.get("Option"))
2710
2724
  memeber_set = set(params.keys())
2711
2725
  for name, value in vars(self).items():
2712
2726
  property_name = name[1:]
@@ -3782,8 +3796,10 @@ class ChannelCreateFlowSignReviewRequest(AbstractModel):
3782
3796
  <li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>
3783
3797
  <li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>
3784
3798
  :type ReviewMessage: str
3785
- :param _RecipientId: 审核节点的签署人标志,用于指定当前审核的签署方
3786
- <ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>
3799
+ :param _RecipientId: 审核节点的签署人标志,用于指定当前审核的签署方。
3800
+ <font color= "red">注意:以下情况必须传递RecipientId</font>
3801
+ <ul><li> **发起签署流程时,指定签署人需要审批(即签署人需要审批
3802
+ <a href="https://qian.tencent.com/developers/partnerApis/dataTypes#flowapproverinfo" target="_blank">ApproverNeedSignReview</a>为true),则必须指定RecipientId**</li><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>
3787
3803
  :type RecipientId: str
3788
3804
  :param _OperateType: 流程审核操作类型,取值如下:
3789
3805
  <ul><li>**SignReview**:(默认)签署审核</li>
@@ -3917,14 +3933,15 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
3917
3933
  :param _FlowApproverInfos: 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId,其他可不传。
3918
3934
 
3919
3935
  注:
3920
- `1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
3936
+ `1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
3921
3937
  `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
3922
3938
  :type FlowApproverInfos: list of FlowApproverInfo
3923
3939
  :param _Operator: 用户信息,暂未开放
3924
3940
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
3925
3941
  :param _Organization: 机构信息,暂未开放
3926
3942
  :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
3927
- :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
3943
+ :param _JumpUrl: 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
3944
+
3928
3945
  :type JumpUrl: str
3929
3946
  :param _UrlType: 链接类型,支持指定以下类型
3930
3947
  <ul><li>0 : 签署链接 (默认值)</li>
@@ -4333,7 +4350,12 @@ class ChannelCreateOrganizationBatchSignUrlRequest(AbstractModel):
4333
4350
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4334
4351
  :param _FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
4335
4352
  :type FlowIds: list of str
4336
- :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
4353
+ :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。
4354
+
4355
+ <ul>
4356
+ <li>1. 若OpenId为空,Name和Mobile 必须提供。</li>
4357
+ <li>2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。 </li>
4358
+ </ul>
4337
4359
  :type OpenId: str
4338
4360
  :param _Name: 签署方经办人的姓名。
4339
4361
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
@@ -6952,22 +6974,20 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6952
6974
  </ul>
6953
6975
  第三方平台子客企业和员工必须已经经过实名认证
6954
6976
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6955
- :param _Limit: 返回最大数量,最大为100
6977
+ :param _Limit: 指定分页每页返回的数据条数,单页最大支持 100
6956
6978
  :type Limit: int
6957
6979
  :param _Offset: 分页查询偏移量,默认为0,最大为20000
6958
6980
  :type Offset: int
6959
- :param _InfoType: 查询信息类型
6960
- 支持的值如下:
6961
- <ul><li>0-默认,不返回授权用户信息</li>
6962
- <li>1-返回授权用户信息</li>
6963
- </ul>
6981
+ :param _InfoType: 查询授权用户信息类型,取值如下:
6982
+
6983
+ <ul> <li><b>0</b>:(默认)不返回授权用户信息</li> <li><b>1</b>:返回授权用户的信息</li> </ul>
6964
6984
  :type InfoType: int
6965
- :param _SealId: 印章id(没有输入返回所有)
6985
+ :param _SealId: 印章id,是否查询特定的印章(没有输入返回所有)
6966
6986
 
6967
6987
  注: `没有输入返回所有记录,最大返回100条。`
6968
6988
  :type SealId: str
6969
6989
  :param _SealTypes: 电子印章类型 , 可选类型如下:
6970
- <ul><li>**OFFICIAL**: (默认)公章</li>
6990
+ <ul><li>**OFFICIAL**: 公章</li>
6971
6991
  <li>**CONTRACT**: 合同专用章;</li>
6972
6992
  <li>**FINANCE**: 财务专用章;</li>
6973
6993
  <li>**PERSONNEL**: 人事专用章</li>
@@ -6976,6 +6996,11 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6976
6996
 
6977
6997
  注: `为空时查询所有类型的印章。`
6978
6998
  :type SealTypes: list of str
6999
+ :param _SealStatuses:
7000
+ 需查询的印章状态列表。
7001
+
7002
+ <ul> <li>空,()仅查询启用状态的印章;</li> <li><strong>ALL</strong>,查询所有状态的印章;</li> <li><strong>CHECKING</strong>,查询待审核的印章;</li> <li><strong>SUCCESS</strong>,查询启用状态的印章;</li> <li><strong>FAIL</strong>,查询印章审核拒绝的印章;</li> <li><strong>DISABLE</strong>,查询已停用的印章;</li> <li><strong>STOPPED</strong>,查询已终止的印章;</li> <li><strong>VOID</strong>,查询已作废的印章;</li> <li><strong>INVALID</strong>,查询已失效的印章。</li> </ul>
7003
+ :type SealStatuses: list of str
6979
7004
  """
6980
7005
  self._Agent = None
6981
7006
  self._Limit = None
@@ -6983,6 +7008,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6983
7008
  self._InfoType = None
6984
7009
  self._SealId = None
6985
7010
  self._SealTypes = None
7011
+ self._SealStatuses = None
6986
7012
 
6987
7013
  @property
6988
7014
  def Agent(self):
@@ -7032,6 +7058,14 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
7032
7058
  def SealTypes(self, SealTypes):
7033
7059
  self._SealTypes = SealTypes
7034
7060
 
7061
+ @property
7062
+ def SealStatuses(self):
7063
+ return self._SealStatuses
7064
+
7065
+ @SealStatuses.setter
7066
+ def SealStatuses(self, SealStatuses):
7067
+ self._SealStatuses = SealStatuses
7068
+
7035
7069
 
7036
7070
  def _deserialize(self, params):
7037
7071
  if params.get("Agent") is not None:
@@ -7042,6 +7076,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
7042
7076
  self._InfoType = params.get("InfoType")
7043
7077
  self._SealId = params.get("SealId")
7044
7078
  self._SealTypes = params.get("SealTypes")
7079
+ self._SealStatuses = params.get("SealStatuses")
7045
7080
  memeber_set = set(params.keys())
7046
7081
  for name, value in vars(self).items():
7047
7082
  property_name = name[1:]
@@ -7059,7 +7094,7 @@ class ChannelDescribeOrganizationSealsResponse(AbstractModel):
7059
7094
 
7060
7095
  def __init__(self):
7061
7096
  r"""
7062
- :param _TotalCount: 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
7097
+ :param _TotalCount: 在设定了SealId时,返回值为0或1;若未设定SealId,则返回公司的总印章数量
7063
7098
  :type TotalCount: int
7064
7099
  :param _Seals: 查询到的印章结果数组
7065
7100
  :type Seals: list of OccupiedSeal
@@ -8994,8 +9029,6 @@ class Component(AbstractModel):
8994
9029
  1. 绝对定位方式 (可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标)
8995
9030
  2. 表单域(FIELD)定位方式
8996
9031
  3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
8997
- 可以参考官网说明
8998
- https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
8999
9032
 
9000
9033
  """
9001
9034
 
@@ -9111,7 +9144,13 @@ class Component(AbstractModel):
9111
9144
  <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
9112
9145
  <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
9113
9146
  印章的对应关系参考下图
9114
- ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
9147
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
9148
+ <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
9149
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
9150
+ <li> <b>CONTRACT</b> : 合同专用章</li>
9151
+ <li> <b>FINANCE</b> : 财务专用章</li>
9152
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
9153
+ <b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
9115
9154
 
9116
9155
  <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
9117
9156
  <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
@@ -9150,7 +9189,7 @@ class Component(AbstractModel):
9150
9189
 
9151
9190
 
9152
9191
  <b>控件值约束说明</b>:
9153
- <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
9192
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr><tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
9154
9193
  注: `部分特殊控件需要在控制台配置模板形式创建`
9155
9194
  :type ComponentValue: str
9156
9195
  :param _ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
@@ -9500,7 +9539,14 @@ class ComponentLimit(AbstractModel):
9500
9539
  :type ComponentType: str
9501
9540
  :param _ComponentValue: 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
9502
9541
 
9503
- 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
9542
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型
9543
+
9544
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
9545
+ <li> <b>CONTRACT</b> : 合同专用章</li>
9546
+ <li> <b>FINANCE</b> : 财务专用章</li>
9547
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
9548
+
9549
+ 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
9504
9550
 
9505
9551
  2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
9506
9552
 
@@ -9977,7 +10023,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
9977
10023
  `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一,员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
9978
10024
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9979
10025
  :param _ProxyOrganizationName: 第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。
9980
- 在测试环境联调的过程中,企业名称请统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。
10026
+ <font color="red">在测试环境联调的过程中,企业名称请使用以下名称
10027
+ **子客测试专用企业1 - 子客测试专用企业9**</font>
9981
10028
 
9982
10029
  注:
9983
10030
  `1. 如果名称中包含英文括号(),请使用中文括号()代替。`
@@ -10293,6 +10340,114 @@ class CreateConsoleLoginUrlResponse(AbstractModel):
10293
10340
  self._RequestId = params.get("RequestId")
10294
10341
 
10295
10342
 
10343
+ class CreateFlowBlockchainEvidenceUrlRequest(AbstractModel):
10344
+ """CreateFlowBlockchainEvidenceUrl请求参数结构体
10345
+
10346
+ """
10347
+
10348
+ def __init__(self):
10349
+ r"""
10350
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul>
10351
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10352
+ :param _FlowId: 合同流程ID,为32位字符串。建议开发者妥善保存此流程ID,以便于顺利进行后续操作。可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
10353
+ :type FlowId: str
10354
+ """
10355
+ self._Agent = None
10356
+ self._FlowId = None
10357
+
10358
+ @property
10359
+ def Agent(self):
10360
+ return self._Agent
10361
+
10362
+ @Agent.setter
10363
+ def Agent(self, Agent):
10364
+ self._Agent = Agent
10365
+
10366
+ @property
10367
+ def FlowId(self):
10368
+ return self._FlowId
10369
+
10370
+ @FlowId.setter
10371
+ def FlowId(self, FlowId):
10372
+ self._FlowId = FlowId
10373
+
10374
+
10375
+ def _deserialize(self, params):
10376
+ if params.get("Agent") is not None:
10377
+ self._Agent = Agent()
10378
+ self._Agent._deserialize(params.get("Agent"))
10379
+ self._FlowId = params.get("FlowId")
10380
+ memeber_set = set(params.keys())
10381
+ for name, value in vars(self).items():
10382
+ property_name = name[1:]
10383
+ if property_name in memeber_set:
10384
+ memeber_set.remove(property_name)
10385
+ if len(memeber_set) > 0:
10386
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
10387
+
10388
+
10389
+
10390
+ class CreateFlowBlockchainEvidenceUrlResponse(AbstractModel):
10391
+ """CreateFlowBlockchainEvidenceUrl返回参数结构体
10392
+
10393
+ """
10394
+
10395
+ def __init__(self):
10396
+ r"""
10397
+ :param _QrCode: 二维码图片下载链接,下载链接有效时间5分钟,请尽快下载保存。
10398
+ :type QrCode: str
10399
+ :param _Url: 查看短链,可直接点击短链查看证书。
10400
+ :type Url: str
10401
+ :param _ExpiredOn: 二维码和短链的过期时间戳,过期时间默认为生成链接后7天。
10402
+ :type ExpiredOn: int
10403
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10404
+ :type RequestId: str
10405
+ """
10406
+ self._QrCode = None
10407
+ self._Url = None
10408
+ self._ExpiredOn = None
10409
+ self._RequestId = None
10410
+
10411
+ @property
10412
+ def QrCode(self):
10413
+ return self._QrCode
10414
+
10415
+ @QrCode.setter
10416
+ def QrCode(self, QrCode):
10417
+ self._QrCode = QrCode
10418
+
10419
+ @property
10420
+ def Url(self):
10421
+ return self._Url
10422
+
10423
+ @Url.setter
10424
+ def Url(self, Url):
10425
+ self._Url = Url
10426
+
10427
+ @property
10428
+ def ExpiredOn(self):
10429
+ return self._ExpiredOn
10430
+
10431
+ @ExpiredOn.setter
10432
+ def ExpiredOn(self, ExpiredOn):
10433
+ self._ExpiredOn = ExpiredOn
10434
+
10435
+ @property
10436
+ def RequestId(self):
10437
+ return self._RequestId
10438
+
10439
+ @RequestId.setter
10440
+ def RequestId(self, RequestId):
10441
+ self._RequestId = RequestId
10442
+
10443
+
10444
+ def _deserialize(self, params):
10445
+ self._QrCode = params.get("QrCode")
10446
+ self._Url = params.get("Url")
10447
+ self._ExpiredOn = params.get("ExpiredOn")
10448
+ self._RequestId = params.get("RequestId")
10449
+
10450
+
10296
10451
  class CreateFlowGroupSignReviewRequest(AbstractModel):
10297
10452
  """CreateFlowGroupSignReview请求参数结构体
10298
10453
 
@@ -10784,6 +10939,126 @@ class CreateFlowsByTemplatesResponse(AbstractModel):
10784
10939
  self._RequestId = params.get("RequestId")
10785
10940
 
10786
10941
 
10942
+ class CreateLegalSealQrCodeRequest(AbstractModel):
10943
+ """CreateLegalSealQrCode请求参数结构体
10944
+
10945
+ """
10946
+
10947
+ def __init__(self):
10948
+ r"""
10949
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
10950
+ 此接口下面信息必填。
10951
+ <ul>
10952
+ <li>渠道应用标识: Agent.AppId</li>
10953
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
10954
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
10955
+ </ul>注:
10956
+ `1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识,建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。 `
10957
+ `2. 员工认证时, 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识,建议开发者保存此员工的OpenId,后续各项接口调用皆需要此参数。 `
10958
+ `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一,员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
10959
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10960
+ :param _Operator: 操作人信息
10961
+ :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
10962
+ :param _Organization: 企业信息
10963
+ :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
10964
+ """
10965
+ self._Agent = None
10966
+ self._Operator = None
10967
+ self._Organization = None
10968
+
10969
+ @property
10970
+ def Agent(self):
10971
+ return self._Agent
10972
+
10973
+ @Agent.setter
10974
+ def Agent(self, Agent):
10975
+ self._Agent = Agent
10976
+
10977
+ @property
10978
+ def Operator(self):
10979
+ warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
10980
+
10981
+ return self._Operator
10982
+
10983
+ @Operator.setter
10984
+ def Operator(self, Operator):
10985
+ warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
10986
+
10987
+ self._Operator = Operator
10988
+
10989
+ @property
10990
+ def Organization(self):
10991
+ warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
10992
+
10993
+ return self._Organization
10994
+
10995
+ @Organization.setter
10996
+ def Organization(self, Organization):
10997
+ warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
10998
+
10999
+ self._Organization = Organization
11000
+
11001
+
11002
+ def _deserialize(self, params):
11003
+ if params.get("Agent") is not None:
11004
+ self._Agent = Agent()
11005
+ self._Agent._deserialize(params.get("Agent"))
11006
+ if params.get("Operator") is not None:
11007
+ self._Operator = UserInfo()
11008
+ self._Operator._deserialize(params.get("Operator"))
11009
+ if params.get("Organization") is not None:
11010
+ self._Organization = OrganizationInfo()
11011
+ self._Organization._deserialize(params.get("Organization"))
11012
+ memeber_set = set(params.keys())
11013
+ for name, value in vars(self).items():
11014
+ property_name = name[1:]
11015
+ if property_name in memeber_set:
11016
+ memeber_set.remove(property_name)
11017
+ if len(memeber_set) > 0:
11018
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
11019
+
11020
+
11021
+
11022
+ class CreateLegalSealQrCodeResponse(AbstractModel):
11023
+ """CreateLegalSealQrCode返回参数结构体
11024
+
11025
+ """
11026
+
11027
+ def __init__(self):
11028
+ r"""
11029
+ :param _QrcodeBase64: 二维码图片base64值,二维码有效期7天(604800秒)
11030
+
11031
+ 二维码图片的样式如下图:
11032
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec2478761158a35a9c623882839a5df.png)
11033
+ :type QrcodeBase64: str
11034
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11035
+ :type RequestId: str
11036
+ """
11037
+ self._QrcodeBase64 = None
11038
+ self._RequestId = None
11039
+
11040
+ @property
11041
+ def QrcodeBase64(self):
11042
+ return self._QrcodeBase64
11043
+
11044
+ @QrcodeBase64.setter
11045
+ def QrcodeBase64(self, QrcodeBase64):
11046
+ self._QrcodeBase64 = QrcodeBase64
11047
+
11048
+ @property
11049
+ def RequestId(self):
11050
+ return self._RequestId
11051
+
11052
+ @RequestId.setter
11053
+ def RequestId(self, RequestId):
11054
+ self._RequestId = RequestId
11055
+
11056
+
11057
+ def _deserialize(self, params):
11058
+ self._QrcodeBase64 = params.get("QrcodeBase64")
11059
+ self._RequestId = params.get("RequestId")
11060
+
11061
+
10787
11062
  class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10788
11063
  """CreatePartnerAutoSignAuthUrl请求参数结构体
10789
11064
 
@@ -10813,11 +11088,19 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10813
11088
  注:该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”,请联系运营经理开通
10814
11089
 
10815
11090
  :type PlatformAppAuthorization: bool
11091
+ :param _SealTypes: 指定印章类型,指定后只能选择该类型的印章进行授权
11092
+ 支持以下印章类型:
11093
+ - OFFICIAL : 企业公章
11094
+ - CONTRACT : 合同专用章
11095
+ - FINANCE : 财务专用章
11096
+ - PERSONNEL : 人事专用章
11097
+ :type SealTypes: list of str
10816
11098
  """
10817
11099
  self._Agent = None
10818
11100
  self._AuthorizedOrganizationId = None
10819
11101
  self._AuthorizedOrganizationName = None
10820
11102
  self._PlatformAppAuthorization = None
11103
+ self._SealTypes = None
10821
11104
 
10822
11105
  @property
10823
11106
  def Agent(self):
@@ -10851,6 +11134,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10851
11134
  def PlatformAppAuthorization(self, PlatformAppAuthorization):
10852
11135
  self._PlatformAppAuthorization = PlatformAppAuthorization
10853
11136
 
11137
+ @property
11138
+ def SealTypes(self):
11139
+ return self._SealTypes
11140
+
11141
+ @SealTypes.setter
11142
+ def SealTypes(self, SealTypes):
11143
+ self._SealTypes = SealTypes
11144
+
10854
11145
 
10855
11146
  def _deserialize(self, params):
10856
11147
  if params.get("Agent") is not None:
@@ -10859,6 +11150,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10859
11150
  self._AuthorizedOrganizationId = params.get("AuthorizedOrganizationId")
10860
11151
  self._AuthorizedOrganizationName = params.get("AuthorizedOrganizationName")
10861
11152
  self._PlatformAppAuthorization = params.get("PlatformAppAuthorization")
11153
+ self._SealTypes = params.get("SealTypes")
10862
11154
  memeber_set = set(params.keys())
10863
11155
  for name, value in vars(self).items():
10864
11156
  property_name = name[1:]
@@ -10992,8 +11284,12 @@ class CreateSealByImageRequest(AbstractModel):
10992
11284
  <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
10993
11285
  :type SealSize: str
10994
11286
  :param _TaxIdentifyCode: 企业税号
10995
- 注: `1.印章类型SealType是INVOICE类型时,此参数才会生效`
10996
- `2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号`
11287
+
11288
+ 注:
11289
+ <ul>
11290
+ <li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li>
11291
+ <li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color="red">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li>
11292
+ </ul>
10997
11293
  :type TaxIdentifyCode: str
10998
11294
  """
10999
11295
  self._Agent = None
@@ -13310,6 +13606,57 @@ class DownloadFlowInfo(AbstractModel):
13310
13606
 
13311
13607
 
13312
13608
 
13609
+ class EmbedUrlOption(AbstractModel):
13610
+ """创建嵌入式页面url个性化参数
13611
+
13612
+ """
13613
+
13614
+ def __init__(self):
13615
+ r"""
13616
+ :param _ShowFlowDetailComponent: 合同详情预览,允许展示控件信息
13617
+ <ul>
13618
+ <li><b>true</b>:允许在合同详情页展示控件</li>
13619
+ <li><b>false</b>:(默认)不允许在合同详情页展示控件</li>
13620
+ </ul>
13621
+ :type ShowFlowDetailComponent: bool
13622
+ :param _ShowTemplateComponent: 模板预览,允许展示模板控件信息
13623
+ <ul><li> <b>true</b> :允许在模板预览页展示控件</li>
13624
+ <li> <b>false</b> :(默认)不允许在模板预览页展示控件</li></ul>
13625
+ :type ShowTemplateComponent: bool
13626
+ """
13627
+ self._ShowFlowDetailComponent = None
13628
+ self._ShowTemplateComponent = None
13629
+
13630
+ @property
13631
+ def ShowFlowDetailComponent(self):
13632
+ return self._ShowFlowDetailComponent
13633
+
13634
+ @ShowFlowDetailComponent.setter
13635
+ def ShowFlowDetailComponent(self, ShowFlowDetailComponent):
13636
+ self._ShowFlowDetailComponent = ShowFlowDetailComponent
13637
+
13638
+ @property
13639
+ def ShowTemplateComponent(self):
13640
+ return self._ShowTemplateComponent
13641
+
13642
+ @ShowTemplateComponent.setter
13643
+ def ShowTemplateComponent(self, ShowTemplateComponent):
13644
+ self._ShowTemplateComponent = ShowTemplateComponent
13645
+
13646
+
13647
+ def _deserialize(self, params):
13648
+ self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
13649
+ self._ShowTemplateComponent = params.get("ShowTemplateComponent")
13650
+ memeber_set = set(params.keys())
13651
+ for name, value in vars(self).items():
13652
+ property_name = name[1:]
13653
+ if property_name in memeber_set:
13654
+ memeber_set.remove(property_name)
13655
+ if len(memeber_set) > 0:
13656
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
13657
+
13658
+
13659
+
13313
13660
  class ExtentServiceAuthInfo(AbstractModel):
13314
13661
  """扩展服务开通和授权的详细信息
13315
13662
 
@@ -13975,7 +14322,7 @@ class FlowApproverInfo(AbstractModel):
13975
14322
 
13976
14323
  **各种场景传参说明**:
13977
14324
 
13978
- <table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)ApproverOption.FillType:需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(固定)ApproverType:需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)OrganizationName:SaaS企业的名字</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)NotChannelOrganization:需设置为True</li> </ul> </td> </tr> </tbody> </table>
14325
+ <table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)ApproverOption.FillType:需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(必传)OpenId:企业员工标识</li> <li>(必传)OrganizationName:子企业名称</li> <li>(必传)OrganizationOpenId:子企业的标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(固定)ApproverType:需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>(选填)IdCardNumber和IdCardType:证件类型和证件号</li> <li>(必传)OrganizationName:SaaS企业的名字</li> <li>(必传)Name:签署方的名字</li> <li>(必传)Mobile:签署方的手机号</li> <li>(不传)OrganizationOpenId:子企业的标识</li> <li>(不传)OpenId:企业员工标识</li> <li>(固定)ApproverType:需设置为ORGANIZATION</li> <li>(固定)NotChannelOrganization:需设置为True</li> </ul> </td> </tr> </tbody> </table>
13979
14326
 
13980
14327
 
13981
14328
  **注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
@@ -14115,7 +14462,7 @@ class FlowApproverInfo(AbstractModel):
14115
14462
 
14116
14463
  注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
14117
14464
  :type NotifyType: str
14118
- :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
14465
+ :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。
14119
14466
 
14120
14467
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
14121
14468
  :type AddSignComponentsLimits: list of ComponentLimit
@@ -20042,7 +20389,7 @@ class UploadFile(AbstractModel):
20042
20389
  r"""
20043
20390
  :param _FileBody: Base64编码后的文件内容
20044
20391
  :type FileBody: str
20045
- :param _FileName: 文件名
20392
+ :param _FileName: 文件名,最大长度不超过200字符
20046
20393
  :type FileName: str
20047
20394
  """
20048
20395
  self._FileBody = None
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1165
3
+ Version: 3.0.1183
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common==3.0.1183
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common==3.0.1165