tencentcloud-sdk-python-essbasic 3.0.1156__tar.gz → 3.0.1175__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.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/setup.py +1 -1
  3. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20210526/essbasic_client.py +82 -11
  5. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20210526/models.py +380 -33
  6. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
  7. tencentcloud-sdk-python-essbasic-3.0.1175/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  8. tencentcloud-sdk-python-essbasic-3.0.1156/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  9. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/README.rst +0 -0
  10. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/setup.cfg +0 -0
  11. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/__init__.py +0 -0
  12. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  13. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  15. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1175}/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.1156
3
+ Version: 3.0.1175
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.1156"],
11
+ install_requires=["tencentcloud-sdk-python-common==3.0.1175"],
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.1156'
17
+ __version__ = '3.0.1175'
@@ -215,8 +215,9 @@ class EssbasicClient(AbstractClient):
215
215
  注:
216
216
  - 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
217
217
  - 参与人点击链接后需短信验证码才能查看合同内容。
218
- - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。
219
- - 个人批量签署,签名区`仅支持手写签名`。
218
+ - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,<font color="red">请确保此企业已完成腾讯电子签企业认证</font>。暂时仅支持给<font color="red">自建应用集成企业</font>生成员工批签链接,不支持子客企业。
219
+ - 生成批量签署链接时,合同目标参与方状态需为<font color="red">待签署</font>状态。
220
+ - 个人批量签署进行的合同的签名区, 全部变成<font color="red">手写签名</font>(不管合同里边设置的签名限制)来进行。
220
221
 
221
222
  :param request: Request instance for ChannelCreateBatchSignUrl.
222
223
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchSignUrlRequest`
@@ -395,6 +396,10 @@ class EssbasicClient(AbstractClient):
395
396
 
396
397
  `4. 静默(自动)签署不支持合同签署方存在填写功能`
397
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
+
398
403
  :param request: Request instance for ChannelCreateFlowByFiles.
399
404
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowByFilesRequest`
400
405
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowByFilesResponse`
@@ -662,11 +667,10 @@ class EssbasicClient(AbstractClient):
662
667
  """该接口用于发起合同后,生成用户的签署链接 <br/>
663
668
 
664
669
  **注意**
665
- 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
666
- 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
667
- 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
668
- 跳转到小程序的实现,参考微信官方文档(分为<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>。
669
- 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>。
670
674
 
671
675
  :param request: Request instance for ChannelCreateFlowSignUrl.
672
676
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
@@ -1636,7 +1640,6 @@ class EssbasicClient(AbstractClient):
1636
1640
  <th>子客企业状态</th>
1637
1641
  <th>子客企业员工状态</th>
1638
1642
  <th>点击链接进入的流程</th>
1639
- <th>视频样例</th>
1640
1643
  </tr>
1641
1644
  </thead>
1642
1645
  <tbody>
@@ -1644,19 +1647,16 @@ class EssbasicClient(AbstractClient):
1644
1647
  <td>企业未激活</td>
1645
1648
  <td>员工未认证</td>
1646
1649
  <td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
1647
- <td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
1648
1650
  </tr>
1649
1651
  <tr>
1650
1652
  <td>企业已激活</td>
1651
1653
  <td>员工未认证</td>
1652
1654
  <td>进入员认证并加入企业流程</td>
1653
- <td>-</td>
1654
1655
  </tr>
1655
1656
  <tr>
1656
1657
  <td>企业已激活</td>
1657
1658
  <td>员工已认证</td>
1658
1659
  <td>进入子客企业Web控制台</td>
1659
- <td>-</td>
1660
1660
  </tr>
1661
1661
  </tbody>
1662
1662
  </table>
@@ -1668,6 +1668,10 @@ class EssbasicClient(AbstractClient):
1668
1668
  系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
1669
1669
  ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
1670
1670
 
1671
+
1672
+ <font color="red">相关视频指引</font> <br>
1673
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4" target="_blank">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>
1674
+
1671
1675
  :param request: Request instance for CreateConsoleLoginUrl.
1672
1676
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlRequest`
1673
1677
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlResponse`
@@ -1688,6 +1692,39 @@ class EssbasicClient(AbstractClient):
1688
1692
  raise TencentCloudSDKException(type(e).__name__, str(e))
1689
1693
 
1690
1694
 
1695
+ def CreateFlowBlockchainEvidenceUrl(self, request):
1696
+ """获取区块链存证报告查看链接/二维码接口
1697
+
1698
+ 适用场景:企业员工可以通过此接口生成合同区块链存证报告的查看链接/二维码,以供他人扫码打开腾讯电子签小程序查看。
1699
+
1700
+ [点击查看区块链存证报告样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
1701
+
1702
+ 注:
1703
+ <ul><li>1. 二维码下载链接过期时间为5分钟,请尽快下载保存。二维码/短链的过期时间为<font color="red">7天</font>,超过有效期则不可用。</li>
1704
+ <li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成报告查看二维码/短链。</li>
1705
+ <li>3. 调用接口时,需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>
1706
+ <li>4. 通过扫码或者点击链接,用户无需登录或者鉴权即可查看对应合同的区块链存证报告,请妥善保管好二维码或链接。</li></ul>
1707
+
1708
+ :param request: Request instance for CreateFlowBlockchainEvidenceUrl.
1709
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowBlockchainEvidenceUrlRequest`
1710
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowBlockchainEvidenceUrlResponse`
1711
+
1712
+ """
1713
+ try:
1714
+ params = request._serialize()
1715
+ headers = request.headers
1716
+ body = self.call("CreateFlowBlockchainEvidenceUrl", params, headers=headers)
1717
+ response = json.loads(body)
1718
+ model = models.CreateFlowBlockchainEvidenceUrlResponse()
1719
+ model._deserialize(response["Response"])
1720
+ return model
1721
+ except Exception as e:
1722
+ if isinstance(e, TencentCloudSDKException):
1723
+ raise
1724
+ else:
1725
+ raise TencentCloudSDKException(type(e).__name__, str(e))
1726
+
1727
+
1691
1728
  def CreateFlowGroupSignReview(self, request):
1692
1729
  """1. 在使用[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles)或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时,若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
1693
1730
  - [FlowInfo.NeedSignReview](https://qian.tencent.com/developers/partnerApis/dataTypes/#flowinfo)
@@ -1777,6 +1814,11 @@ class EssbasicClient(AbstractClient):
1777
1814
 
1778
1815
  5. <font color="red">在下一步创建签署链接前,建议等待DocumentFill </font> <a href="https://qian.tencent.com/developers/partner/callback_types_file_resources">PDF合成完成的回调</a>或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
1779
1816
 
1817
+
1818
+ <font color="red">相关视频指引</font> <br>
1819
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
1820
+ 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateFlowsByTemplates.mp4" target="_blank">【用模板创建签署流程】编写示例视频教程</a><br>
1821
+
1780
1822
  :param request: Request instance for CreateFlowsByTemplates.
1781
1823
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesRequest`
1782
1824
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesResponse`
@@ -1797,6 +1839,29 @@ class EssbasicClient(AbstractClient):
1797
1839
  raise TencentCloudSDKException(type(e).__name__, str(e))
1798
1840
 
1799
1841
 
1842
+ def CreateLegalSealQrCode(self, request):
1843
+ """此接口用于获取创建法人章二维码图片base64
1844
+
1845
+ :param request: Request instance for CreateLegalSealQrCode.
1846
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateLegalSealQrCodeRequest`
1847
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateLegalSealQrCodeResponse`
1848
+
1849
+ """
1850
+ try:
1851
+ params = request._serialize()
1852
+ headers = request.headers
1853
+ body = self.call("CreateLegalSealQrCode", params, headers=headers)
1854
+ response = json.loads(body)
1855
+ model = models.CreateLegalSealQrCodeResponse()
1856
+ model._deserialize(response["Response"])
1857
+ return model
1858
+ except Exception as e:
1859
+ if isinstance(e, TencentCloudSDKException):
1860
+ raise
1861
+ else:
1862
+ raise TencentCloudSDKException(type(e).__name__, str(e))
1863
+
1864
+
1800
1865
  def CreatePartnerAutoSignAuthUrl(self, request):
1801
1866
  """创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。
1802
1867
  该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
@@ -2185,6 +2250,9 @@ class EssbasicClient(AbstractClient):
2185
2250
  >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
2186
2251
  >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
2187
2252
 
2253
+ <font color="red">相关视频指引</font> <br>
2254
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
2255
+
2188
2256
  :param request: Request instance for DescribeTemplates.
2189
2257
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeTemplatesRequest`
2190
2258
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeTemplatesResponse`
@@ -2486,6 +2554,9 @@ class EssbasicClient(AbstractClient):
2486
2554
  httpProfile.setEndpoint("file.test.ess.tencent.cn");
2487
2555
  ```
2488
2556
 
2557
+ <font color="red">相关视频指引</font> <br>
2558
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
2559
+
2489
2560
  :param request: Request instance for UploadFiles.
2490
2561
  :type request: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesRequest`
2491
2562
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesResponse`
@@ -2065,18 +2065,18 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
2065
2065
  :param _Name: 签署方经办人的姓名。
2066
2066
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2067
2067
 
2068
- 注:`请确保和合同中填入的一致`
2068
+ 注:`请确保和合同中填入的一致`,`除动态签署人场景外,此参数必填`
2069
2069
  :type Name: str
2070
2070
  :param _Mobile: 手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
2071
2071
  请确认手机号所有方为此业务通知方。
2072
2072
 
2073
- 注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`
2073
+ 注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`,`除动态签署人场景外,此参数必填`
2074
2074
  :type Mobile: str
2075
2075
  :param _Operator: 执行本接口操作的员工信息。
2076
2076
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2077
2077
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
2078
2078
  :param _IdCardType: 证件类型,支持以下类型
2079
- <ul><li>**ID_CARD** : 居民身份证 (默认值)</li>
2079
+ <ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>
2080
2080
  <li>**HONGKONG_AND_MACAO** : 港澳居民来往内地通行证</li>
2081
2081
  <li>**HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证)</li></ul>
2082
2082
 
@@ -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:]
@@ -3917,14 +3931,15 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
3917
3931
  :param _FlowApproverInfos: 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId,其他可不传。
3918
3932
 
3919
3933
  注:
3920
- `1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
3934
+ `1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
3921
3935
  `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
3922
3936
  :type FlowApproverInfos: list of FlowApproverInfo
3923
3937
  :param _Operator: 用户信息,暂未开放
3924
3938
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
3925
3939
  :param _Organization: 机构信息,暂未开放
3926
3940
  :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
3927
- :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
3941
+ :param _JumpUrl: 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
3942
+
3928
3943
  :type JumpUrl: str
3929
3944
  :param _UrlType: 链接类型,支持指定以下类型
3930
3945
  <ul><li>0 : 签署链接 (默认值)</li>
@@ -4333,7 +4348,12 @@ class ChannelCreateOrganizationBatchSignUrlRequest(AbstractModel):
4333
4348
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4334
4349
  :param _FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
4335
4350
  :type FlowIds: list of str
4336
- :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
4351
+ :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。
4352
+
4353
+ <ul>
4354
+ <li>1. 若OpenId为空,Name和Mobile 必须提供。</li>
4355
+ <li>2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。 </li>
4356
+ </ul>
4337
4357
  :type OpenId: str
4338
4358
  :param _Name: 签署方经办人的姓名。
4339
4359
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
@@ -4820,7 +4840,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
4820
4840
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4821
4841
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
4822
4842
  :param _IdCardType: 证件类型,支持以下类型
4823
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
4843
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
4824
4844
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4825
4845
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
4826
4846
  <li>OTHER_CARD_TYPE : 其他</li></ul>
@@ -6976,6 +6996,8 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6976
6996
 
6977
6997
  注: `为空时查询所有类型的印章。`
6978
6998
  :type SealTypes: list of str
6999
+ :param _SealStatuses: 查询的印章状态列表。 <ul> <li>空,只查询启用状态的印章;</li> <li>ALL,查询所有状态的印章;</li> <li>CHECKING,查询待审核的印章;</li> <li>SUCCESS,查询启用状态的印章;</li> <li>FAIL,查询印章审核拒绝的印章;</li> <li>DISABLE,查询已停用的印章;</li> <li>STOPPED,查询已终止的印章;</li> <li>VOID,查询已作废的印章;</li> <li>INVALID,查询已失效的印章;</li> </ul>
7000
+ :type SealStatuses: list of str
6979
7001
  """
6980
7002
  self._Agent = None
6981
7003
  self._Limit = None
@@ -6983,6 +7005,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6983
7005
  self._InfoType = None
6984
7006
  self._SealId = None
6985
7007
  self._SealTypes = None
7008
+ self._SealStatuses = None
6986
7009
 
6987
7010
  @property
6988
7011
  def Agent(self):
@@ -7032,6 +7055,14 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
7032
7055
  def SealTypes(self, SealTypes):
7033
7056
  self._SealTypes = SealTypes
7034
7057
 
7058
+ @property
7059
+ def SealStatuses(self):
7060
+ return self._SealStatuses
7061
+
7062
+ @SealStatuses.setter
7063
+ def SealStatuses(self, SealStatuses):
7064
+ self._SealStatuses = SealStatuses
7065
+
7035
7066
 
7036
7067
  def _deserialize(self, params):
7037
7068
  if params.get("Agent") is not None:
@@ -7042,6 +7073,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
7042
7073
  self._InfoType = params.get("InfoType")
7043
7074
  self._SealId = params.get("SealId")
7044
7075
  self._SealTypes = params.get("SealTypes")
7076
+ self._SealStatuses = params.get("SealStatuses")
7045
7077
  memeber_set = set(params.keys())
7046
7078
  for name, value in vars(self).items():
7047
7079
  property_name = name[1:]
@@ -9074,6 +9106,7 @@ class Component(AbstractModel):
9074
9106
 
9075
9107
  :type ComponentHeight: float
9076
9108
  :param _ComponentPage: **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
9109
+ **在使用文件发起的情况下**,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。
9077
9110
 
9078
9111
  注:
9079
9112
  1. 页码编号是从<font color="red">1</font>开始编号的。
@@ -9110,7 +9143,13 @@ class Component(AbstractModel):
9110
9143
  <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
9111
9144
  <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
9112
9145
  印章的对应关系参考下图
9113
- ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
9146
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
9147
+ <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
9148
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
9149
+ <li> <b>CONTRACT</b> : 合同专用章</li>
9150
+ <li> <b>FINANCE</b> : 财务专用章</li>
9151
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
9152
+ <b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
9114
9153
 
9115
9154
  <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
9116
9155
  <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
@@ -9138,12 +9177,12 @@ class Component(AbstractModel):
9138
9177
  :type ComponentExtra: str
9139
9178
  :param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
9140
9179
  <ul><li> <b>TEXT</b> : 文本内容</li>
9141
- <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
9180
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \n 来控制换行位置</li>
9142
9181
  <li> <b>CHECK_BOX</b> : true/false</li>
9143
9182
  <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
9144
9183
  <li> <b>SELECTOR</b> : 选项值</li>
9145
9184
  <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
9146
- <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
9185
+ <li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>
9147
9186
  <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>
9148
9187
  <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>
9149
9188
 
@@ -9178,8 +9217,8 @@ class Component(AbstractModel):
9178
9217
  <ul><li> <b>Middle</b> :居中</li>
9179
9218
  <li> <b>Below</b> :正下方</li>
9180
9219
  <li> <b>Right</b> :正右方</li>
9181
- <li> <b>LowerRight</b> :右上角</li>
9182
- <li> <b>UpperRight</b> :右下角。</li></ul>
9220
+ <li> <b>LowerRight</b> :右下角</li>
9221
+ <li> <b>UpperRight</b> :右上角。</li></ul>
9183
9222
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
9184
9223
  :type RelativeLocation: str
9185
9224
  :param _KeywordIndexes: **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
@@ -9499,7 +9538,14 @@ class ComponentLimit(AbstractModel):
9499
9538
  :type ComponentType: str
9500
9539
  :param _ComponentValue: 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
9501
9540
 
9502
- 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
9541
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型
9542
+
9543
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
9544
+ <li> <b>CONTRACT</b> : 合同专用章</li>
9545
+ <li> <b>FINANCE</b> : 财务专用章</li>
9546
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
9547
+
9548
+ 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
9503
9549
 
9504
9550
  2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
9505
9551
 
@@ -9975,7 +10021,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
9975
10021
  `2. 员工认证时, 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识,建议开发者保存此员工的OpenId,后续各项接口调用皆需要此参数。 `
9976
10022
  `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一,员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
9977
10023
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9978
- :param _ProxyOrganizationName: 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
10024
+ :param _ProxyOrganizationName: 第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。
10025
+ 在测试环境联调的过程中,企业名称请统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。
9979
10026
 
9980
10027
  注:
9981
10028
  `1. 如果名称中包含英文括号(),请使用中文括号()代替。`
@@ -10291,6 +10338,114 @@ class CreateConsoleLoginUrlResponse(AbstractModel):
10291
10338
  self._RequestId = params.get("RequestId")
10292
10339
 
10293
10340
 
10341
+ class CreateFlowBlockchainEvidenceUrlRequest(AbstractModel):
10342
+ """CreateFlowBlockchainEvidenceUrl请求参数结构体
10343
+
10344
+ """
10345
+
10346
+ def __init__(self):
10347
+ r"""
10348
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul>
10349
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10350
+ :param _FlowId: 合同流程ID,为32位字符串。建议开发者妥善保存此流程ID,以便于顺利进行后续操作。可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
10351
+ :type FlowId: str
10352
+ """
10353
+ self._Agent = None
10354
+ self._FlowId = None
10355
+
10356
+ @property
10357
+ def Agent(self):
10358
+ return self._Agent
10359
+
10360
+ @Agent.setter
10361
+ def Agent(self, Agent):
10362
+ self._Agent = Agent
10363
+
10364
+ @property
10365
+ def FlowId(self):
10366
+ return self._FlowId
10367
+
10368
+ @FlowId.setter
10369
+ def FlowId(self, FlowId):
10370
+ self._FlowId = FlowId
10371
+
10372
+
10373
+ def _deserialize(self, params):
10374
+ if params.get("Agent") is not None:
10375
+ self._Agent = Agent()
10376
+ self._Agent._deserialize(params.get("Agent"))
10377
+ self._FlowId = params.get("FlowId")
10378
+ memeber_set = set(params.keys())
10379
+ for name, value in vars(self).items():
10380
+ property_name = name[1:]
10381
+ if property_name in memeber_set:
10382
+ memeber_set.remove(property_name)
10383
+ if len(memeber_set) > 0:
10384
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
10385
+
10386
+
10387
+
10388
+ class CreateFlowBlockchainEvidenceUrlResponse(AbstractModel):
10389
+ """CreateFlowBlockchainEvidenceUrl返回参数结构体
10390
+
10391
+ """
10392
+
10393
+ def __init__(self):
10394
+ r"""
10395
+ :param _QrCode: 二维码图片下载链接,下载链接有效时间5分钟,请尽快下载保存。
10396
+ :type QrCode: str
10397
+ :param _Url: 查看短链,可直接点击短链查看报告。
10398
+ :type Url: str
10399
+ :param _ExpiredOn: 二维码和短链的过期时间戳,过期时间默认为生成链接后7天。
10400
+ :type ExpiredOn: int
10401
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10402
+ :type RequestId: str
10403
+ """
10404
+ self._QrCode = None
10405
+ self._Url = None
10406
+ self._ExpiredOn = None
10407
+ self._RequestId = None
10408
+
10409
+ @property
10410
+ def QrCode(self):
10411
+ return self._QrCode
10412
+
10413
+ @QrCode.setter
10414
+ def QrCode(self, QrCode):
10415
+ self._QrCode = QrCode
10416
+
10417
+ @property
10418
+ def Url(self):
10419
+ return self._Url
10420
+
10421
+ @Url.setter
10422
+ def Url(self, Url):
10423
+ self._Url = Url
10424
+
10425
+ @property
10426
+ def ExpiredOn(self):
10427
+ return self._ExpiredOn
10428
+
10429
+ @ExpiredOn.setter
10430
+ def ExpiredOn(self, ExpiredOn):
10431
+ self._ExpiredOn = ExpiredOn
10432
+
10433
+ @property
10434
+ def RequestId(self):
10435
+ return self._RequestId
10436
+
10437
+ @RequestId.setter
10438
+ def RequestId(self, RequestId):
10439
+ self._RequestId = RequestId
10440
+
10441
+
10442
+ def _deserialize(self, params):
10443
+ self._QrCode = params.get("QrCode")
10444
+ self._Url = params.get("Url")
10445
+ self._ExpiredOn = params.get("ExpiredOn")
10446
+ self._RequestId = params.get("RequestId")
10447
+
10448
+
10294
10449
  class CreateFlowGroupSignReviewRequest(AbstractModel):
10295
10450
  """CreateFlowGroupSignReview请求参数结构体
10296
10451
 
@@ -10782,6 +10937,123 @@ class CreateFlowsByTemplatesResponse(AbstractModel):
10782
10937
  self._RequestId = params.get("RequestId")
10783
10938
 
10784
10939
 
10940
+ class CreateLegalSealQrCodeRequest(AbstractModel):
10941
+ """CreateLegalSealQrCode请求参数结构体
10942
+
10943
+ """
10944
+
10945
+ def __init__(self):
10946
+ r"""
10947
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
10948
+ 此接口下面信息必填。
10949
+ <ul>
10950
+ <li>渠道应用标识: Agent.AppId</li>
10951
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
10952
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
10953
+ </ul>注:
10954
+ `1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识,建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。 `
10955
+ `2. 员工认证时, 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识,建议开发者保存此员工的OpenId,后续各项接口调用皆需要此参数。 `
10956
+ `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一,员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
10957
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10958
+ :param _Operator: 操作人信息
10959
+ :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
10960
+ :param _Organization: 企业信息
10961
+ :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
10962
+ """
10963
+ self._Agent = None
10964
+ self._Operator = None
10965
+ self._Organization = None
10966
+
10967
+ @property
10968
+ def Agent(self):
10969
+ return self._Agent
10970
+
10971
+ @Agent.setter
10972
+ def Agent(self, Agent):
10973
+ self._Agent = Agent
10974
+
10975
+ @property
10976
+ def Operator(self):
10977
+ warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
10978
+
10979
+ return self._Operator
10980
+
10981
+ @Operator.setter
10982
+ def Operator(self, Operator):
10983
+ warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
10984
+
10985
+ self._Operator = Operator
10986
+
10987
+ @property
10988
+ def Organization(self):
10989
+ warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
10990
+
10991
+ return self._Organization
10992
+
10993
+ @Organization.setter
10994
+ def Organization(self, Organization):
10995
+ warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
10996
+
10997
+ self._Organization = Organization
10998
+
10999
+
11000
+ def _deserialize(self, params):
11001
+ if params.get("Agent") is not None:
11002
+ self._Agent = Agent()
11003
+ self._Agent._deserialize(params.get("Agent"))
11004
+ if params.get("Operator") is not None:
11005
+ self._Operator = UserInfo()
11006
+ self._Operator._deserialize(params.get("Operator"))
11007
+ if params.get("Organization") is not None:
11008
+ self._Organization = OrganizationInfo()
11009
+ self._Organization._deserialize(params.get("Organization"))
11010
+ memeber_set = set(params.keys())
11011
+ for name, value in vars(self).items():
11012
+ property_name = name[1:]
11013
+ if property_name in memeber_set:
11014
+ memeber_set.remove(property_name)
11015
+ if len(memeber_set) > 0:
11016
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
11017
+
11018
+
11019
+
11020
+ class CreateLegalSealQrCodeResponse(AbstractModel):
11021
+ """CreateLegalSealQrCode返回参数结构体
11022
+
11023
+ """
11024
+
11025
+ def __init__(self):
11026
+ r"""
11027
+ :param _QrcodeBase64: 二维码图片base64值
11028
+ :type QrcodeBase64: str
11029
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11030
+ :type RequestId: str
11031
+ """
11032
+ self._QrcodeBase64 = None
11033
+ self._RequestId = None
11034
+
11035
+ @property
11036
+ def QrcodeBase64(self):
11037
+ return self._QrcodeBase64
11038
+
11039
+ @QrcodeBase64.setter
11040
+ def QrcodeBase64(self, QrcodeBase64):
11041
+ self._QrcodeBase64 = QrcodeBase64
11042
+
11043
+ @property
11044
+ def RequestId(self):
11045
+ return self._RequestId
11046
+
11047
+ @RequestId.setter
11048
+ def RequestId(self, RequestId):
11049
+ self._RequestId = RequestId
11050
+
11051
+
11052
+ def _deserialize(self, params):
11053
+ self._QrcodeBase64 = params.get("QrcodeBase64")
11054
+ self._RequestId = params.get("RequestId")
11055
+
11056
+
10785
11057
  class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10786
11058
  """CreatePartnerAutoSignAuthUrl请求参数结构体
10787
11059
 
@@ -10811,11 +11083,19 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10811
11083
  注:该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”,请联系运营经理开通
10812
11084
 
10813
11085
  :type PlatformAppAuthorization: bool
11086
+ :param _SealTypes: 指定印章类型,指定后只能选择该类型的印章进行授权
11087
+ 支持以下印章类型:
11088
+ - OFFICIAL : 企业公章
11089
+ - CONTRACT : 合同专用章
11090
+ - FINANCE : 财务专用章
11091
+ - PERSONNEL : 人事专用章
11092
+ :type SealTypes: list of str
10814
11093
  """
10815
11094
  self._Agent = None
10816
11095
  self._AuthorizedOrganizationId = None
10817
11096
  self._AuthorizedOrganizationName = None
10818
11097
  self._PlatformAppAuthorization = None
11098
+ self._SealTypes = None
10819
11099
 
10820
11100
  @property
10821
11101
  def Agent(self):
@@ -10849,6 +11129,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10849
11129
  def PlatformAppAuthorization(self, PlatformAppAuthorization):
10850
11130
  self._PlatformAppAuthorization = PlatformAppAuthorization
10851
11131
 
11132
+ @property
11133
+ def SealTypes(self):
11134
+ return self._SealTypes
11135
+
11136
+ @SealTypes.setter
11137
+ def SealTypes(self, SealTypes):
11138
+ self._SealTypes = SealTypes
11139
+
10852
11140
 
10853
11141
  def _deserialize(self, params):
10854
11142
  if params.get("Agent") is not None:
@@ -10857,6 +11145,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
10857
11145
  self._AuthorizedOrganizationId = params.get("AuthorizedOrganizationId")
10858
11146
  self._AuthorizedOrganizationName = params.get("AuthorizedOrganizationName")
10859
11147
  self._PlatformAppAuthorization = params.get("PlatformAppAuthorization")
11148
+ self._SealTypes = params.get("SealTypes")
10860
11149
  memeber_set = set(params.keys())
10861
11150
  for name, value in vars(self).items():
10862
11151
  property_name = name[1:]
@@ -10990,8 +11279,12 @@ class CreateSealByImageRequest(AbstractModel):
10990
11279
  <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
10991
11280
  :type SealSize: str
10992
11281
  :param _TaxIdentifyCode: 企业税号
10993
- 注: `1.印章类型SealType是INVOICE类型时,此参数才会生效`
10994
- `2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号`
11282
+
11283
+ 注:
11284
+ <ul>
11285
+ <li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li>
11286
+ <li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color="red">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li>
11287
+ </ul>
10995
11288
  :type TaxIdentifyCode: str
10996
11289
  """
10997
11290
  self._Agent = None
@@ -13308,6 +13601,57 @@ class DownloadFlowInfo(AbstractModel):
13308
13601
 
13309
13602
 
13310
13603
 
13604
+ class EmbedUrlOption(AbstractModel):
13605
+ """创建嵌入式页面url个性化参数
13606
+
13607
+ """
13608
+
13609
+ def __init__(self):
13610
+ r"""
13611
+ :param _ShowFlowDetailComponent: 合同详情预览,允许展示控件信息
13612
+ <ul>
13613
+ <li><b>true</b>:允许在合同详情页展示控件</li>
13614
+ <li><b>false</b>:(默认)不允许在合同详情页展示控件</li>
13615
+ </ul>
13616
+ :type ShowFlowDetailComponent: bool
13617
+ :param _ShowTemplateComponent: 模板预览,允许展示模板控件信息
13618
+ <ul><li> <b>true</b> :允许在模板预览页展示控件</li>
13619
+ <li> <b>false</b> :(默认)不允许在模板预览页展示控件</li></ul>
13620
+ :type ShowTemplateComponent: bool
13621
+ """
13622
+ self._ShowFlowDetailComponent = None
13623
+ self._ShowTemplateComponent = None
13624
+
13625
+ @property
13626
+ def ShowFlowDetailComponent(self):
13627
+ return self._ShowFlowDetailComponent
13628
+
13629
+ @ShowFlowDetailComponent.setter
13630
+ def ShowFlowDetailComponent(self, ShowFlowDetailComponent):
13631
+ self._ShowFlowDetailComponent = ShowFlowDetailComponent
13632
+
13633
+ @property
13634
+ def ShowTemplateComponent(self):
13635
+ return self._ShowTemplateComponent
13636
+
13637
+ @ShowTemplateComponent.setter
13638
+ def ShowTemplateComponent(self, ShowTemplateComponent):
13639
+ self._ShowTemplateComponent = ShowTemplateComponent
13640
+
13641
+
13642
+ def _deserialize(self, params):
13643
+ self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
13644
+ self._ShowTemplateComponent = params.get("ShowTemplateComponent")
13645
+ memeber_set = set(params.keys())
13646
+ for name, value in vars(self).items():
13647
+ property_name = name[1:]
13648
+ if property_name in memeber_set:
13649
+ memeber_set.remove(property_name)
13650
+ if len(memeber_set) > 0:
13651
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
13652
+
13653
+
13654
+
13311
13655
  class ExtentServiceAuthInfo(AbstractModel):
13312
13656
  """扩展服务开通和授权的详细信息
13313
13657
 
@@ -13474,7 +13818,7 @@ class FillApproverInfo(AbstractModel):
13474
13818
  :param _NotChannelOrganization: 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,OrganizationOpenId 必传
13475
13819
  :type NotChannelOrganization: bool
13476
13820
  :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
13477
- <ul><li>ID_CARD 居民身份证</li>
13821
+ <ul><li>ID_CARD 中国大陆居民身份证</li>
13478
13822
  <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
13479
13823
  <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
13480
13824
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
@@ -13973,7 +14317,7 @@ class FlowApproverInfo(AbstractModel):
13973
14317
 
13974
14318
  **各种场景传参说明**:
13975
14319
 
13976
- <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>
14320
+ <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>
13977
14321
 
13978
14322
 
13979
14323
  **注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
@@ -13991,7 +14335,7 @@ class FlowApproverInfo(AbstractModel):
13991
14335
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
13992
14336
  :type Name: str
13993
14337
  :param _IdCardType: 签署方经办人的证件类型,支持以下类型
13994
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
14338
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
13995
14339
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
13996
14340
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
13997
14341
  <li>OTHER_CARD_TYPE : 其他证件</li></ul>
@@ -14113,7 +14457,7 @@ class FlowApproverInfo(AbstractModel):
14113
14457
 
14114
14458
  注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
14115
14459
  :type NotifyType: str
14116
- :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
14460
+ :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。
14117
14461
 
14118
14462
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
14119
14463
  :type AddSignComponentsLimits: list of ComponentLimit
@@ -15754,17 +16098,20 @@ class FormField(AbstractModel):
15754
16098
  def __init__(self):
15755
16099
  r"""
15756
16100
  :param _ComponentValue: 控件填充值,ComponentType和传入值格式对应关系如下:
15757
- <ul>
15758
- <li>TEXT - 普通文本控件,需输入文本字符串;</li>
15759
- <li>MULTI_LINE_TEXT - 多行文本控件,需输入文本字符串;</li>
15760
- <li>CHECK_BOX - 勾选框控件,若选中需填写ComponentValue,填写 true或者 false 字符串;</li>
15761
- <li>FILL_IMAGE - 图片控件,需填写ComponentValue为图片的资源 ID;</li>
15762
- <li>DYNAMIC_TABLE - 动态表格控件;</li>
15763
- <li>ATTACHMENT - 附件控件,需填写ComponentValue为附件图片的资源 ID列表,以逗号分割;</li>
15764
- <li>DATE - 日期控件;格式为 <b>xxxx年xx月xx日</b> 字符串;</li>
15765
- <li>DISTRICT - 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容;</li>
16101
+ <ul><li> <b>TEXT</b> : 文本内容</li>
16102
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \n 来控制换行位置</li>
16103
+ <li> <b>CHECK_BOX</b> : true/false</li>
16104
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
16105
+ <li> <b>SELECTOR</b> : 选项值</li>
16106
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>
16107
+ <li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>
16108
+ <li> <b>DISTRICT </b> : 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容</li>
15766
16109
  </ul>
15767
16110
 
16111
+
16112
+ <b>控件值约束说明</b>:
16113
+ <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>
16114
+
15768
16115
  :type ComponentValue: str
15769
16116
  :param _ComponentId: 表单域或控件的ID,跟ComponentName二选一,不能全为空;
15770
16117
  CreateFlowsByTemplates 接口不使用此字段。
@@ -16623,7 +16970,7 @@ class NeedReviewApproverInfo(AbstractModel):
16623
16970
  :param _ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
16624
16971
  :type ApproverMobile: str
16625
16972
  :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
16626
- <ul><li>ID_CARD 居民身份证 (默认值)</li>
16973
+ <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
16627
16974
  <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
16628
16975
  <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
16629
16976
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
@@ -17859,7 +18206,7 @@ class ProxyOrganizationOperator(AbstractModel):
17859
18206
  员工的姓名将用于身份认证和电子签名,请确保填写的姓名为真实姓名,而非昵称等代名。
17860
18207
  :type Name: str
17861
18208
  :param _IdCardType: 签署方经办人的证件类型,支持以下类型
17862
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
18209
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
17863
18210
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
17864
18211
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
17865
18212
 
@@ -19568,7 +19915,7 @@ class SyncProxyOrganizationRequest(AbstractModel):
19568
19915
  :param _Operator: 暂未开放
19569
19916
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
19570
19917
  :param _ProxyLegalIdCardType: 第三方平台子客企业法定代表人的证件类型,支持以下类型
19571
- <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
19918
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>
19572
19919
  注: `现在仅支持ID_CARD居民身份证类型`
19573
19920
  :type ProxyLegalIdCardType: str
19574
19921
  :param _ProxyLegalIdCardNumber: 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
@@ -20442,7 +20789,7 @@ class UserThreeFactor(AbstractModel):
20442
20789
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
20443
20790
  :type Name: str
20444
20791
  :param _IdCardType: 证件类型,支持以下类型
20445
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
20792
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
20446
20793
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
20447
20794
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
20448
20795
  :type IdCardType: str
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1156
3
+ Version: 3.0.1175
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.1175
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common==3.0.1156