tencentcloud-sdk-python-essbasic 3.0.1155__py2.py3-none-any.whl → 3.0.1168__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
tencentcloud/__init__.py CHANGED
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1155'
17
+ __version__ = '3.0.1168'
@@ -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`
@@ -662,11 +663,10 @@ class EssbasicClient(AbstractClient):
662
663
  """该接口用于发起合同后,生成用户的签署链接 <br/>
663
664
 
664
665
  **注意**
665
- 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件** 。
666
- 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
667
- 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
666
+ 1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
667
+ 2. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
668
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>。
669
+ 3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
670
670
 
671
671
  :param request: Request instance for ChannelCreateFlowSignUrl.
672
672
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
@@ -1636,7 +1636,6 @@ class EssbasicClient(AbstractClient):
1636
1636
  <th>子客企业状态</th>
1637
1637
  <th>子客企业员工状态</th>
1638
1638
  <th>点击链接进入的流程</th>
1639
- <th>视频样例</th>
1640
1639
  </tr>
1641
1640
  </thead>
1642
1641
  <tbody>
@@ -1644,19 +1643,16 @@ class EssbasicClient(AbstractClient):
1644
1643
  <td>企业未激活</td>
1645
1644
  <td>员工未认证</td>
1646
1645
  <td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
1647
- <td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
1648
1646
  </tr>
1649
1647
  <tr>
1650
1648
  <td>企业已激活</td>
1651
1649
  <td>员工未认证</td>
1652
1650
  <td>进入员认证并加入企业流程</td>
1653
- <td>-</td>
1654
1651
  </tr>
1655
1652
  <tr>
1656
1653
  <td>企业已激活</td>
1657
1654
  <td>员工已认证</td>
1658
1655
  <td>进入子客企业Web控制台</td>
1659
- <td>-</td>
1660
1656
  </tr>
1661
1657
  </tbody>
1662
1658
  </table>
@@ -1668,6 +1664,10 @@ class EssbasicClient(AbstractClient):
1668
1664
  系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
1669
1665
  ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
1670
1666
 
1667
+
1668
+ <font color="red">相关视频指引</font> <br>
1669
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4" target="_blank">【生成子客登录链接】代码编写 & 子企业认证示例</a><br>
1670
+
1671
1671
  :param request: Request instance for CreateConsoleLoginUrl.
1672
1672
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlRequest`
1673
1673
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlResponse`
@@ -2486,6 +2486,9 @@ class EssbasicClient(AbstractClient):
2486
2486
  httpProfile.setEndpoint("file.test.ess.tencent.cn");
2487
2487
  ```
2488
2488
 
2489
+ <font color="red">相关视频指引</font> <br>
2490
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
2491
+
2489
2492
  :param request: Request instance for UploadFiles.
2490
2493
  :type request: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesRequest`
2491
2494
  :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:]
@@ -4333,7 +4347,12 @@ class ChannelCreateOrganizationBatchSignUrlRequest(AbstractModel):
4333
4347
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4334
4348
  :param _FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
4335
4349
  :type FlowIds: list of str
4336
- :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
4350
+ :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。
4351
+
4352
+ <ul>
4353
+ <li>1. 若OpenId为空,Name和Mobile 必须提供。</li>
4354
+ <li>2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。 </li>
4355
+ </ul>
4337
4356
  :type OpenId: str
4338
4357
  :param _Name: 签署方经办人的姓名。
4339
4358
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
@@ -4820,7 +4839,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
4820
4839
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4821
4840
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
4822
4841
  :param _IdCardType: 证件类型,支持以下类型
4823
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
4842
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
4824
4843
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4825
4844
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
4826
4845
  <li>OTHER_CARD_TYPE : 其他</li></ul>
@@ -6976,6 +6995,8 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6976
6995
 
6977
6996
  注: `为空时查询所有类型的印章。`
6978
6997
  :type SealTypes: list of str
6998
+ :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>
6999
+ :type SealStatuses: list of str
6979
7000
  """
6980
7001
  self._Agent = None
6981
7002
  self._Limit = None
@@ -6983,6 +7004,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
6983
7004
  self._InfoType = None
6984
7005
  self._SealId = None
6985
7006
  self._SealTypes = None
7007
+ self._SealStatuses = None
6986
7008
 
6987
7009
  @property
6988
7010
  def Agent(self):
@@ -7032,6 +7054,14 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
7032
7054
  def SealTypes(self, SealTypes):
7033
7055
  self._SealTypes = SealTypes
7034
7056
 
7057
+ @property
7058
+ def SealStatuses(self):
7059
+ return self._SealStatuses
7060
+
7061
+ @SealStatuses.setter
7062
+ def SealStatuses(self, SealStatuses):
7063
+ self._SealStatuses = SealStatuses
7064
+
7035
7065
 
7036
7066
  def _deserialize(self, params):
7037
7067
  if params.get("Agent") is not None:
@@ -7042,6 +7072,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
7042
7072
  self._InfoType = params.get("InfoType")
7043
7073
  self._SealId = params.get("SealId")
7044
7074
  self._SealTypes = params.get("SealTypes")
7075
+ self._SealStatuses = params.get("SealStatuses")
7045
7076
  memeber_set = set(params.keys())
7046
7077
  for name, value in vars(self).items():
7047
7078
  property_name = name[1:]
@@ -9074,6 +9105,7 @@ class Component(AbstractModel):
9074
9105
 
9075
9106
  :type ComponentHeight: float
9076
9107
  :param _ComponentPage: **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
9108
+ **在使用文件发起的情况下**,绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码,使用负数时,页码从最后一页开始。例如:ComponentPage设置为-1,即代表在PDF文件的最后一页,以此类推。
9077
9109
 
9078
9110
  注:
9079
9111
  1. 页码编号是从<font color="red">1</font>开始编号的。
@@ -9110,7 +9142,13 @@ class Component(AbstractModel):
9110
9142
  <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
9111
9143
  <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
9112
9144
  印章的对应关系参考下图
9113
- ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
9145
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
9146
+ <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
9147
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
9148
+ <li> <b>CONTRACT</b> : 合同专用章</li>
9149
+ <li> <b>FINANCE</b> : 财务专用章</li>
9150
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
9151
+ <b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
9114
9152
 
9115
9153
  <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
9116
9154
  <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
@@ -9138,12 +9176,12 @@ class Component(AbstractModel):
9138
9176
  :type ComponentExtra: str
9139
9177
  :param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
9140
9178
  <ul><li> <b>TEXT</b> : 文本内容</li>
9141
- <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
9179
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \n 来控制换行位置</li>
9142
9180
  <li> <b>CHECK_BOX</b> : true/false</li>
9143
9181
  <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
9144
9182
  <li> <b>SELECTOR</b> : 选项值</li>
9145
9183
  <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
9146
- <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
9184
+ <li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>
9147
9185
  <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>
9148
9186
  <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取,[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>
9149
9187
 
@@ -9178,8 +9216,8 @@ class Component(AbstractModel):
9178
9216
  <ul><li> <b>Middle</b> :居中</li>
9179
9217
  <li> <b>Below</b> :正下方</li>
9180
9218
  <li> <b>Right</b> :正右方</li>
9181
- <li> <b>LowerRight</b> :右上角</li>
9182
- <li> <b>UpperRight</b> :右下角。</li></ul>
9219
+ <li> <b>LowerRight</b> :右下角</li>
9220
+ <li> <b>UpperRight</b> :右上角。</li></ul>
9183
9221
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
9184
9222
  :type RelativeLocation: str
9185
9223
  :param _KeywordIndexes: **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
@@ -9499,7 +9537,14 @@ class ComponentLimit(AbstractModel):
9499
9537
  :type ComponentType: str
9500
9538
  :param _ComponentValue: 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
9501
9539
 
9502
- 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
9540
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型
9541
+
9542
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
9543
+ <li> <b>CONTRACT</b> : 合同专用章</li>
9544
+ <li> <b>FINANCE</b> : 财务专用章</li>
9545
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
9546
+
9547
+ 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
9503
9548
 
9504
9549
  2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
9505
9550
 
@@ -9975,7 +10020,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
9975
10020
  `2. 员工认证时, 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识,建议开发者保存此员工的OpenId,后续各项接口调用皆需要此参数。 `
9976
10021
  `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一,员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
9977
10022
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9978
- :param _ProxyOrganizationName: 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
10023
+ :param _ProxyOrganizationName: 第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。
10024
+ 在测试环境联调的过程中,企业名称请统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。
9979
10025
 
9980
10026
  注:
9981
10027
  `1. 如果名称中包含英文括号(),请使用中文括号()代替。`
@@ -13308,6 +13354,57 @@ class DownloadFlowInfo(AbstractModel):
13308
13354
 
13309
13355
 
13310
13356
 
13357
+ class EmbedUrlOption(AbstractModel):
13358
+ """创建嵌入式页面url个性化参数
13359
+
13360
+ """
13361
+
13362
+ def __init__(self):
13363
+ r"""
13364
+ :param _ShowFlowDetailComponent: 合同详情页面是否展示合同控件信息
13365
+ <br/>true:允许在合同详情页展示控件
13366
+ <br/>false:不允许在合同详情页展示控件
13367
+ <br/>默认false,在合同详情页不展示控件
13368
+ :type ShowFlowDetailComponent: bool
13369
+ :param _ShowTemplateComponent: 模版预览页面是否展示空间信息
13370
+ <br/>true:允许在模版预览页展示控件
13371
+ <br/>false:不允许在模版预览页展示控件
13372
+ <br/>默认false,在模版预览页不展示控件
13373
+ :type ShowTemplateComponent: bool
13374
+ """
13375
+ self._ShowFlowDetailComponent = None
13376
+ self._ShowTemplateComponent = None
13377
+
13378
+ @property
13379
+ def ShowFlowDetailComponent(self):
13380
+ return self._ShowFlowDetailComponent
13381
+
13382
+ @ShowFlowDetailComponent.setter
13383
+ def ShowFlowDetailComponent(self, ShowFlowDetailComponent):
13384
+ self._ShowFlowDetailComponent = ShowFlowDetailComponent
13385
+
13386
+ @property
13387
+ def ShowTemplateComponent(self):
13388
+ return self._ShowTemplateComponent
13389
+
13390
+ @ShowTemplateComponent.setter
13391
+ def ShowTemplateComponent(self, ShowTemplateComponent):
13392
+ self._ShowTemplateComponent = ShowTemplateComponent
13393
+
13394
+
13395
+ def _deserialize(self, params):
13396
+ self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
13397
+ self._ShowTemplateComponent = params.get("ShowTemplateComponent")
13398
+ memeber_set = set(params.keys())
13399
+ for name, value in vars(self).items():
13400
+ property_name = name[1:]
13401
+ if property_name in memeber_set:
13402
+ memeber_set.remove(property_name)
13403
+ if len(memeber_set) > 0:
13404
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
13405
+
13406
+
13407
+
13311
13408
  class ExtentServiceAuthInfo(AbstractModel):
13312
13409
  """扩展服务开通和授权的详细信息
13313
13410
 
@@ -13474,7 +13571,7 @@ class FillApproverInfo(AbstractModel):
13474
13571
  :param _NotChannelOrganization: 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,OrganizationOpenId 必传
13475
13572
  :type NotChannelOrganization: bool
13476
13573
  :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
13477
- <ul><li>ID_CARD 居民身份证</li>
13574
+ <ul><li>ID_CARD 中国大陆居民身份证</li>
13478
13575
  <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
13479
13576
  <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
13480
13577
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
@@ -13973,7 +14070,7 @@ class FlowApproverInfo(AbstractModel):
13973
14070
 
13974
14071
  **各种场景传参说明**:
13975
14072
 
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>
14073
+ <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
14074
 
13978
14075
 
13979
14076
  **注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
@@ -13991,7 +14088,7 @@ class FlowApproverInfo(AbstractModel):
13991
14088
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
13992
14089
  :type Name: str
13993
14090
  :param _IdCardType: 签署方经办人的证件类型,支持以下类型
13994
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
14091
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
13995
14092
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
13996
14093
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
13997
14094
  <li>OTHER_CARD_TYPE : 其他证件</li></ul>
@@ -14113,7 +14210,7 @@ class FlowApproverInfo(AbstractModel):
14113
14210
 
14114
14211
  注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
14115
14212
  :type NotifyType: str
14116
- :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
14213
+ :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID,或者印章类型)或签名方式。
14117
14214
 
14118
14215
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
14119
14216
  :type AddSignComponentsLimits: list of ComponentLimit
@@ -15754,17 +15851,20 @@ class FormField(AbstractModel):
15754
15851
  def __init__(self):
15755
15852
  r"""
15756
15853
  :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>
15854
+ <ul><li> <b>TEXT</b> : 文本内容</li>
15855
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \n 来控制换行位置</li>
15856
+ <li> <b>CHECK_BOX</b> : true/false</li>
15857
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
15858
+ <li> <b>SELECTOR</b> : 选项值</li>
15859
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>
15860
+ <li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>
15861
+ <li> <b>DISTRICT </b> : 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容</li>
15766
15862
  </ul>
15767
15863
 
15864
+
15865
+ <b>控件值约束说明</b>:
15866
+ <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>
15867
+
15768
15868
  :type ComponentValue: str
15769
15869
  :param _ComponentId: 表单域或控件的ID,跟ComponentName二选一,不能全为空;
15770
15870
  CreateFlowsByTemplates 接口不使用此字段。
@@ -16623,7 +16723,7 @@ class NeedReviewApproverInfo(AbstractModel):
16623
16723
  :param _ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
16624
16724
  :type ApproverMobile: str
16625
16725
  :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
16626
- <ul><li>ID_CARD 居民身份证 (默认值)</li>
16726
+ <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
16627
16727
  <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
16628
16728
  <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
16629
16729
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
@@ -17859,7 +17959,7 @@ class ProxyOrganizationOperator(AbstractModel):
17859
17959
  员工的姓名将用于身份认证和电子签名,请确保填写的姓名为真实姓名,而非昵称等代名。
17860
17960
  :type Name: str
17861
17961
  :param _IdCardType: 签署方经办人的证件类型,支持以下类型
17862
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
17962
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
17863
17963
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
17864
17964
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
17865
17965
 
@@ -19568,7 +19668,7 @@ class SyncProxyOrganizationRequest(AbstractModel):
19568
19668
  :param _Operator: 暂未开放
19569
19669
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
19570
19670
  :param _ProxyLegalIdCardType: 第三方平台子客企业法定代表人的证件类型,支持以下类型
19571
- <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
19671
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>
19572
19672
  注: `现在仅支持ID_CARD居民身份证类型`
19573
19673
  :type ProxyLegalIdCardType: str
19574
19674
  :param _ProxyLegalIdCardNumber: 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
@@ -20442,7 +20542,7 @@ class UserThreeFactor(AbstractModel):
20442
20542
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
20443
20543
  :type Name: str
20444
20544
  :param _IdCardType: 证件类型,支持以下类型
20445
- <ul><li>ID_CARD : 居民身份证 (默认值)</li>
20545
+ <ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
20446
20546
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
20447
20547
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
20448
20548
  :type IdCardType: str
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1155
3
+ Version: 3.0.1168
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common (==3.0.1155)
18
+ Requires-Dist: tencentcloud-sdk-python-common (==3.0.1168)
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -1,4 +1,4 @@
1
- tencentcloud/__init__.py,sha256=MkEuK0t9eshD8bBxYOnqtepAWB-dtSTVuB2AdW5yYrw,631
1
+ tencentcloud/__init__.py,sha256=e9nrTO_hEjRjcZZrPWzIQqj0lLm8BmsRuAd4tIxAlb0,631
2
2
  tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
3
  tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
4
  tencentcloud/essbasic/v20201222/errorcodes.py,sha256=cZPs0vLmArRFQoZqxM4alb0WeBF9f0V0IHmt65dUdxs,5392
@@ -6,9 +6,9 @@ tencentcloud/essbasic/v20201222/essbasic_client.py,sha256=kua9joup-BLKbyITYpVovM
6
6
  tencentcloud/essbasic/v20201222/models.py,sha256=Q2E6jmVT1emRziwRN-qj8XpdzpxvqqHTKOEQz8JaM_s,270905
7
7
  tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
8
8
  tencentcloud/essbasic/v20210526/errorcodes.py,sha256=L1_0J4AOPtBTgtVqauXq0aVisXRe03bOUWFB0QCnXRs,18219
9
- tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=kLfFYzJKuUJ_KcnN3BCBjTnk1fRU_BfMarqRO0pn1Es,134699
10
- tencentcloud/essbasic/v20210526/models.py,sha256=NFpqbIOqmDj9hB6_CuYqBKPyEuC-7xt6EzJcJdd09Xw,740411
11
- tencentcloud_sdk_python_essbasic-3.0.1155.dist-info/METADATA,sha256=0U1-nFcvSfRYqWiof_S2Rtz-yW6FrOEAQdSzsi0UfbA,1517
12
- tencentcloud_sdk_python_essbasic-3.0.1155.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
13
- tencentcloud_sdk_python_essbasic-3.0.1155.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
14
- tencentcloud_sdk_python_essbasic-3.0.1155.dist-info/RECORD,,
9
+ tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=9s8qFKbbkWNvIRuVTdSZjxQKEviLuBub_LUPHv1zCIk,135061
10
+ tencentcloud/essbasic/v20210526/models.py,sha256=3wBgawjsuQHghZzCxdGVtdhLaxG7_Sh0B1VGQL7AmKw,747474
11
+ tencentcloud_sdk_python_essbasic-3.0.1168.dist-info/METADATA,sha256=IaDR-ok_pzJme_trYN1Xpq7xnFqpdg5u__egEcT_oL4,1517
12
+ tencentcloud_sdk_python_essbasic-3.0.1168.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
13
+ tencentcloud_sdk_python_essbasic-3.0.1168.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
14
+ tencentcloud_sdk_python_essbasic-3.0.1168.dist-info/RECORD,,