tencentcloud-sdk-python-essbasic 3.0.1156__tar.gz → 3.0.1170__tar.gz

{tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1170}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1156
+Version: 3.0.1170
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

{tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1170}/setup.py

@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
 
 setup(
     name='tencentcloud-sdk-python-essbasic',
-    install_requires=["tencentcloud-sdk-python-common==3.0.1156"],
+    install_requires=["tencentcloud-sdk-python-common==3.0.1170"],
     version=tencentcloud.__version__,
     description='Tencent Cloud Essbasic SDK for Python',
     long_description=open('README.rst').read(),

{tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1170}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1156'
+__version__ = '3.0.1170'

{tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1170}/tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -215,8 +215,9 @@ class EssbasicClient(AbstractClient):
         注：
         - 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
         - 参与人点击链接后需短信验证码才能查看合同内容。
-        - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接，不支持子客企业。
-        - 个人批量签署，签名区`仅支持手写签名`。
+        - 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，<font color="red">请确保此企业已完成腾讯电子签企业认证</font>。暂时仅支持给<font color="red">自建应用集成企业</font>生成员工批签链接，不支持子客企业。
+        - 生成批量签署链接时，合同目标参与方状态需为<font color="red">待签署</font>状态。
+        - 个人批量签署进行的合同的签名区， 全部变成<font color="red">手写签名</font>（不管合同里边设置的签名限制）来进行。
 
         :param request: Request instance for ChannelCreateBatchSignUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchSignUrlRequest`
@@ -662,11 +663,10 @@ class EssbasicClient(AbstractClient):
         """该接口用于发起合同后，生成用户的签署链接 <br/>
 
         **注意**
-        1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件，**不支持填写控件** 。
-        2. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
-        3. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
+        1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
+        2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
         跳转到小程序的实现，参考微信官方文档（分为<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>。
-        4. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
 
         :param request: Request instance for ChannelCreateFlowSignUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
@@ -1636,7 +1636,6 @@ class EssbasicClient(AbstractClient):
         <th>子客企业状态</th>
         <th>子客企业员工状态</th>
         <th>点击链接进入的流程</th>
-        <th>视频样例</th>
         </tr>
         </thead>
         <tbody>
@@ -1644,19 +1643,16 @@ class EssbasicClient(AbstractClient):
         <td>企业未激活</td>
         <td>员工未认证</td>
         <td>进入企业激活流程，首次完成企业激活流程的员工会成为超管</td>
-        <td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
         </tr>
         <tr>
         <td>企业已激活</td>
         <td>员工未认证</td>
         <td>进入员认证并加入企业流程</td>
-        <td>-</td>
         </tr>
         <tr>
         <td>企业已激活</td>
         <td>员工已认证</td>
         <td>进入子客企业Web控制台</td>
-        <td>-</td>
         </tr>
         </tbody>
         </table>
@@ -1668,6 +1664,10 @@ class EssbasicClient(AbstractClient):
         系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
         ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
 
+
+        <font color="red">相关视频指引</font> <br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-createconsoleloginin.mp4" target="_blank">【生成子客登录链接】代码编写 &  子企业认证示例</a><br>
+
         :param request: Request instance for CreateConsoleLoginUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlResponse`
@@ -2486,6 +2486,9 @@ class EssbasicClient(AbstractClient):
         httpProfile.setEndpoint("file.test.ess.tencent.cn");
         ```
 
+        <font color="red">相关视频指引</font> <br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
+
         :param request: Request instance for UploadFiles.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesResponse`

{tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1170}/tencentcloud/essbasic/v20210526/models.py

@@ -2065,18 +2065,18 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
         :param _Name: 签署方经办人的姓名。
 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
 
-注：`请确保和合同中填入的一致`
+注：`请确保和合同中填入的一致`，`除动态签署人场景外，此参数必填`
         :type Name: str
         :param _Mobile: 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
 请确认手机号所有方为此业务通知方。
 
-注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`
+注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
         :type Mobile: str
         :param _Operator: 执行本接口操作的员工信息。
 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
         :param _IdCardType: 证件类型，支持以下类型
-<ul><li>**ID_CARD** : 居民身份证 (默认值)</li>
+<ul><li>**ID_CARD** : 中国大陆居民身份证 (默认值)</li>
 <li>**HONGKONG_AND_MACAO** : 港澳居民来往内地通行证</li>
 <li>**HONGKONG_MACAO_AND_TAIWAN** : 港澳台居民居住证(格式同居民身份证)</li></ul>
 
@@ -2635,6 +2635,8 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
 </li>
 </ul>
         :type UserData: str
+        :param _Option: 个性化参数，用于控制页面展示内容
+        :type Option: :class:`tencentcloud.essbasic.v20210526.models.EmbedUrlOption`
         """
         self._Agent = None
         self._EmbedType = None
@@ -2642,6 +2644,7 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
         self._HiddenComponents = None
         self._Operator = None
         self._UserData = None
+        self._Option = None
 
     @property
     def Agent(self):
@@ -2695,6 +2698,14 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
     def UserData(self, UserData):
         self._UserData = UserData
 
+    @property
+    def Option(self):
+        return self._Option
+
+    @Option.setter
+    def Option(self, Option):
+        self._Option = Option
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -2707,6 +2718,9 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
         self._UserData = params.get("UserData")
+        if params.get("Option") is not None:
+            self._Option = EmbedUrlOption()
+            self._Option._deserialize(params.get("Option"))
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -4333,7 +4347,12 @@ class ChannelCreateOrganizationBatchSignUrlRequest(AbstractModel):
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
         :param _FlowIds: 请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。	
         :type FlowIds: list of str
-        :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。 - 1. 若OpenId为空，Name和Mobile 必须提供。 - 2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。	
+        :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。
+
+<ul>
+<li>1. 若OpenId为空，Name和Mobile 必须提供。</li>
+<li>2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。	</li>
+</ul>
         :type OpenId: str
         :param _Name: 签署方经办人的姓名。
 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
@@ -4820,7 +4839,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
         :param _IdCardType: 证件类型，支持以下类型
-<ul><li>ID_CARD : 居民身份证 (默认值)</li>
+<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
 <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
 <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
 <li>OTHER_CARD_TYPE : 其他</li></ul>
@@ -6976,6 +6995,8 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
 
 注:  `为空时查询所有类型的印章。`
         :type SealTypes: list of str
+        :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>
+        :type SealStatuses: list of str
         """
         self._Agent = None
         self._Limit = None
@@ -6983,6 +7004,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
         self._InfoType = None
         self._SealId = None
         self._SealTypes = None
+        self._SealStatuses = None
 
     @property
     def Agent(self):
@@ -7032,6 +7054,14 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
     def SealTypes(self, SealTypes):
         self._SealTypes = SealTypes
 
+    @property
+    def SealStatuses(self):
+        return self._SealStatuses
+
+    @SealStatuses.setter
+    def SealStatuses(self, SealStatuses):
+        self._SealStatuses = SealStatuses
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -7042,6 +7072,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
         self._InfoType = params.get("InfoType")
         self._SealId = params.get("SealId")
         self._SealTypes = params.get("SealTypes")
+        self._SealStatuses = params.get("SealStatuses")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -9074,6 +9105,7 @@ class Component(AbstractModel):
 
         :type ComponentHeight: float
         :param _ComponentPage: **在绝对定位方式方式下**，指定控件所在PDF文件上的页码
+**在使用文件发起的情况下**，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。
 
 注：
 1. 页码编号是从<font color="red">1</font>开始编号的。
@@ -9110,7 +9142,13 @@ class Component(AbstractModel):
 <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
 <b>参考样例</b>：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
 印章的对应关系参考下图
-![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
+![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
+<font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型
+<ul><li> <b>OFFICIAL</b> :  企业公章</li>
+<li> <b>CONTRACT</b> : 合同专用章</li>
+<li> <b>FINANCE</b> : 财务专用章</li>
+<li> <b>PERSONNEL</b> : 人事专用章</li></ul>
+<b>参考样例</b>：`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
 
 <font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：
 <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"</li>
@@ -9138,12 +9176,12 @@ class Component(AbstractModel):
         :type ComponentExtra: str
         :param _ComponentValue: 控件填充vaule，ComponentType和传入值类型对应关系：
 <ul><li> <b>TEXT</b> : 文本内容</li>
-<li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
+<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用  \n 来控制换行位置</li>
 <li> <b>CHECK_BOX</b> : true/false</li>
 <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
 <li> <b>SELECTOR</b> : 选项值</li>
 <li> <b>DYNAMIC_TABLE</b>  - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
-<li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
+<li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>
 <li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li>
 <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul>
 
@@ -9178,8 +9216,8 @@ class Component(AbstractModel):
 <ul><li> <b>Middle</b> :居中</li>
 <li> <b>Below</b> :正下方</li>
 <li> <b>Right</b> :正右方</li>
-<li> <b>LowerRight</b> :右上角</li>
-<li> <b>UpperRight</b> :右下角。</li></ul>
+<li> <b>LowerRight</b> :右下角</li>
+<li> <b>UpperRight</b> :右上角。</li></ul>
 示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
         :type RelativeLocation: str
         :param _KeywordIndexes: **如果控件是关键字定位方式**，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
@@ -9499,7 +9537,14 @@ class ComponentLimit(AbstractModel):
         :type ComponentType: str
         :param _ComponentValue: 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
 
-1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）
+1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型
+
+<ul><li> <b>OFFICIAL</b> :  企业公章</li>
+<li> <b>CONTRACT</b> : 合同专用章</li>
+<li> <b>FINANCE</b> : 财务专用章</li>
+<li> <b>PERSONNEL</b> : 人事专用章</li></ul>
+
+注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
 
 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
 
@@ -9975,7 +10020,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
 `2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `
 `3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
-        :param _ProxyOrganizationName: 第三方平台子客企业名称，请确认该名称与企业营业执照中注册的名称一致。
+        :param _ProxyOrganizationName: 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。
+在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。
 
 注:
  `1. 如果名称中包含英文括号()，请使用中文括号（）代替。`
@@ -10811,11 +10857,19 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
  注：该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”，请联系运营经理开通
 
         :type PlatformAppAuthorization: bool
+        :param _SealTypes: 指定印章类型，指定后只能选择该类型的印章进行授权
+支持以下印章类型：
+- OFFICIAL : 企业公章
+- CONTRACT : 合同专用章
+- FINANCE : 财务专用章
+- PERSONNEL : 人事专用章
+        :type SealTypes: list of str
         """
         self._Agent = None
         self._AuthorizedOrganizationId = None
         self._AuthorizedOrganizationName = None
         self._PlatformAppAuthorization = None
+        self._SealTypes = None
 
     @property
     def Agent(self):
@@ -10849,6 +10903,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
     def PlatformAppAuthorization(self, PlatformAppAuthorization):
         self._PlatformAppAuthorization = PlatformAppAuthorization
 
+    @property
+    def SealTypes(self):
+        return self._SealTypes
+
+    @SealTypes.setter
+    def SealTypes(self, SealTypes):
+        self._SealTypes = SealTypes
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -10857,6 +10919,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
         self._AuthorizedOrganizationId = params.get("AuthorizedOrganizationId")
         self._AuthorizedOrganizationName = params.get("AuthorizedOrganizationName")
         self._PlatformAppAuthorization = params.get("PlatformAppAuthorization")
+        self._SealTypes = params.get("SealTypes")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -10990,8 +11053,12 @@ class CreateSealByImageRequest(AbstractModel):
 <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
         :type SealSize: str
         :param _TaxIdentifyCode: 企业税号
-注: `1.印章类型SealType是INVOICE类型时，此参数才会生效`
-`2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号`
+
+注:
+<ul>
+<li>1.印章类型SealType是INVOICE类型时，此参数才会生效</li>
+<li>2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（<font color="red">如果是通过授权书授权方式认证的企业，此参数必传不能为空</font>）</li>
+</ul>
         :type TaxIdentifyCode: str
         """
         self._Agent = None
@@ -13308,6 +13375,57 @@ class DownloadFlowInfo(AbstractModel):
         
 
 
+class EmbedUrlOption(AbstractModel):
+    """创建嵌入式页面url个性化参数
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _ShowFlowDetailComponent: 合同详情页面是否展示合同控件信息
+<br/>true:允许在合同详情页展示控件
+<br/>false:不允许在合同详情页展示控件
+<br/>默认false,在合同详情页不展示控件
+        :type ShowFlowDetailComponent: bool
+        :param _ShowTemplateComponent: 模版预览页面是否展示空间信息
+<br/>true:允许在模版预览页展示控件
+<br/>false:不允许在模版预览页展示控件
+<br/>默认false,在模版预览页不展示控件
+        :type ShowTemplateComponent: bool
+        """
+        self._ShowFlowDetailComponent = None
+        self._ShowTemplateComponent = None
+
+    @property
+    def ShowFlowDetailComponent(self):
+        return self._ShowFlowDetailComponent
+
+    @ShowFlowDetailComponent.setter
+    def ShowFlowDetailComponent(self, ShowFlowDetailComponent):
+        self._ShowFlowDetailComponent = ShowFlowDetailComponent
+
+    @property
+    def ShowTemplateComponent(self):
+        return self._ShowTemplateComponent
+
+    @ShowTemplateComponent.setter
+    def ShowTemplateComponent(self, ShowTemplateComponent):
+        self._ShowTemplateComponent = ShowTemplateComponent
+
+
+    def _deserialize(self, params):
+        self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
+        self._ShowTemplateComponent = params.get("ShowTemplateComponent")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
 class ExtentServiceAuthInfo(AbstractModel):
     """扩展服务开通和授权的详细信息
 
@@ -13474,7 +13592,7 @@ class FillApproverInfo(AbstractModel):
         :param _NotChannelOrganization: 签署企业非渠道子客，默认为false，即表示同一渠道下的企业；如果为true，则目前表示接收方企业为SaaS企业, 为渠道子客时，OrganizationOpenId 必传
         :type NotChannelOrganization: bool
         :param _ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
-<ul><li>ID_CARD 居民身份证</li>
+<ul><li>ID_CARD 中国大陆居民身份证</li>
 <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
 <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
 <li>OTHER_CARD_TYPE 其他证件</li></ul>
@@ -13973,7 +14091,7 @@ class FlowApproverInfo(AbstractModel):
 
     **各种场景传参说明**:
 
-    <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>
+    <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>
 
 
     **注1**: `使用模板发起合同时，RecipientId（模板发起合同时）必传`
@@ -13991,7 +14109,7 @@ class FlowApproverInfo(AbstractModel):
 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
         :type Name: str
         :param _IdCardType: 签署方经办人的证件类型，支持以下类型
-<ul><li>ID_CARD : 居民身份证  (默认值)</li>
+<ul><li>ID_CARD : 中国大陆居民身份证  (默认值)</li>
 <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
 <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
 <li>OTHER_CARD_TYPE : 其他证件</li></ul>
@@ -14113,7 +14231,7 @@ class FlowApproverInfo(AbstractModel):
 
 注: `签署方为第三方子客企业时会被置为NONE,   不会发短信通知`
         :type NotifyType: str
-        :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID）或签名方式。
+        :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。
 
 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
         :type AddSignComponentsLimits: list of ComponentLimit
@@ -15754,17 +15872,20 @@ class FormField(AbstractModel):
     def __init__(self):
         r"""
         :param _ComponentValue: 控件填充值，ComponentType和传入值格式对应关系如下：
-<ul>
-<li>TEXT - 普通文本控件，需输入文本字符串；</li>
-<li>MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串；</li>
-<li>CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串；</li>
-<li>FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID；</li>
-<li>DYNAMIC_TABLE - 动态表格控件；</li>
-<li>ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割；</li>
-<li>DATE - 日期控件；格式为 <b>xxxx年xx月xx日</b> 字符串；</li>
-<li>DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；</li>
+<ul><li> <b>TEXT</b> : 文本内容</li>
+<li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用  \n 来控制换行位置</li>
+<li> <b>CHECK_BOX</b> : true/false</li>
+<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li>
+<li> <b>SELECTOR</b> : 选项值</li>
+<li> <b>DYNAMIC_TABLE</b>  - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>
+<li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li>
+<li> <b>DISTRICT </b> : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容</li>
 </ul>
 
+
+<b>控件值约束说明</b>：
+<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>
+
         :type ComponentValue: str
         :param _ComponentId: 表单域或控件的ID，跟ComponentName二选一，不能全为空；
 CreateFlowsByTemplates 接口不使用此字段。
@@ -16623,7 +16744,7 @@ class NeedReviewApproverInfo(AbstractModel):
         :param _ApproverMobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
         :type ApproverMobile: str
         :param _ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
-<ul><li>ID_CARD 居民身份证  (默认值)</li>
+<ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li>
 <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
 <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
 <li>OTHER_CARD_TYPE 其他证件</li></ul>
@@ -17859,7 +17980,7 @@ class ProxyOrganizationOperator(AbstractModel):
 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为真实姓名，而非昵称等代名。
         :type Name: str
         :param _IdCardType: 签署方经办人的证件类型，支持以下类型
-<ul><li>ID_CARD : 居民身份证  (默认值)</li>
+<ul><li>ID_CARD : 中国大陆居民身份证  (默认值)</li>
 <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
 <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
 
@@ -19568,7 +19689,7 @@ class SyncProxyOrganizationRequest(AbstractModel):
         :param _Operator: 暂未开放
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
         :param _ProxyLegalIdCardType: 第三方平台子客企业法定代表人的证件类型，支持以下类型
-<ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
+<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li></ul>
 注: `现在仅支持ID_CARD居民身份证类型`
         :type ProxyLegalIdCardType: str
         :param _ProxyLegalIdCardNumber: 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
@@ -20442,7 +20563,7 @@ class UserThreeFactor(AbstractModel):
 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
         :type Name: str
         :param _IdCardType: 证件类型，支持以下类型
-<ul><li>ID_CARD : 居民身份证 (默认值)</li>
+<ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li>
 <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
 <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
         :type IdCardType: str

{tencentcloud-sdk-python-essbasic-3.0.1156 → tencentcloud-sdk-python-essbasic-3.0.1170}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1156
+Version: 3.0.1170
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

tencentcloud-sdk-python-essbasic-3.0.1170/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

@@ -0,0 +1 @@
+tencentcloud-sdk-python-common==3.0.1170

tencentcloud-sdk-python-essbasic-3.0.1156/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

@@ -1 +0,0 @@
-tencentcloud-sdk-python-common==3.0.1156