tencentcloud-sdk-python-essbasic 3.0.1381__tar.gz → 3.0.1387__tar.gz

{tencentcloud-sdk-python-essbasic-3.0.1381 → tencentcloud-sdk-python-essbasic-3.0.1387}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1381
+Version: 3.0.1387
 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.1381 → tencentcloud-sdk-python-essbasic-3.0.1387}/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.1381"],
+    install_requires=["tencentcloud-sdk-python-common==3.0.1387"],
     version=tencentcloud.__version__,
     description='Tencent Cloud Essbasic SDK for Python',
     long_description=open('README.rst').read(),

{tencentcloud-sdk-python-essbasic-3.0.1381 → tencentcloud-sdk-python-essbasic-3.0.1387}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1381'
+__version__ = '3.0.1387'

{tencentcloud-sdk-python-essbasic-3.0.1381 → tencentcloud-sdk-python-essbasic-3.0.1387}/tencentcloud/essbasic/v20210526/errorcodes.py

@@ -449,6 +449,9 @@ OPERATIONDENIED_OUTQUERYLIMIT = 'OperationDenied.OutQueryLimit'
 # 当前企业员工没有开通境外签署能力。
 OPERATIONDENIED_OVERSEAABILITYNOTOPEN = 'OperationDenied.OverseaAbilityNotOpen'
 
+# 该用户名下没有可用签名
+OPERATIONDENIED_PERSONHASNOSIGNATURE = 'OperationDenied.PersonHasNoSignature'
+
 # 该用户已关闭或者未开启自动签服务
 OPERATIONDENIED_PERSONNOOPENSERVERSIGN = 'OperationDenied.PersonNoOpenServerSign'
 

{tencentcloud-sdk-python-essbasic-3.0.1381 → tencentcloud-sdk-python-essbasic-3.0.1387}/tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -218,6 +218,7 @@ class EssbasicClient(AbstractClient):
         4. 该接口返回的签署链接适用于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>。
         6. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        7. H5签署现在仅支持中国大陆身份证和中国港澳台居民居住证。
 
         :param request: Request instance for ChannelCreateBatchQuickSignUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchQuickSignUrlRequest`
@@ -757,6 +758,7 @@ class EssbasicClient(AbstractClient):
         2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。配置方式请参考：<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
         如需跳转到小程序的实现，参考微信官方文档（分为<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>。
         3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        4. H5签署现在仅支持中国大陆身份证和中国港澳台居民居住证。
 
         :param request: Request instance for ChannelCreateFlowSignUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
@@ -3003,7 +3005,7 @@ class EssbasicClient(AbstractClient):
     def PrepareFlows(self, request):
         """该接口 (PrepareFlows) 用于创建待发起文件
         用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-        目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
+        目前该接口只支持B2C，<font color='red'> **不建议使用**</font>。
 
         :param request: Request instance for PrepareFlows.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.PrepareFlowsRequest`

{tencentcloud-sdk-python-essbasic-3.0.1381 → tencentcloud-sdk-python-essbasic-3.0.1387}/tencentcloud/essbasic/v20210526/models.py

@@ -856,6 +856,9 @@ class AutoSignConfig(AbstractModel):
         :param _CertInfoCallback: 是否回调证书信息:
 <ul><li>**false**: 不需要(默认)</li>
 <li>**true**:需要</li></ul>
+
+
+注：`该字段已经失效，请勿设置此参数。`
         :type CertInfoCallback: bool
         :param _UserDefineSeal: 是否支持用户自定义签名印章:
 <ul><li>**false**: 不能自己定义(默认)</li>
@@ -869,7 +872,7 @@ class AutoSignConfig(AbstractModel):
         :type CallbackUrl: str
         :param _VerifyChannels: 开通时候的身份验证方式, 取值为：
 <ul><li>**WEIXINAPP** : 微信人脸识别</li>
-<li>**INSIGHT** : 慧眼人脸认别</li>
+<li>**INSIGHT** : 慧眼人脸识别</li>
 <li>**TELECOM** : 运营商三要素验证</li></ul>
 注：
 <ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
@@ -878,6 +881,8 @@ class AutoSignConfig(AbstractModel):
         :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
 
 <ul><li><b>1</b>: (默认)不绑定自动签账号许可开通，开通后一直有效,   后续使用合同份额进行合同发起</li></ul>
+
+注：`该字段已经失效，请勿设置此参数。`
         :type LicenseType: int
         :param _JumpUrl: 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
 
@@ -916,6 +921,9 @@ class AutoSignConfig(AbstractModel):
         """是否回调证书信息:
 <ul><li>**false**: 不需要(默认)</li>
 <li>**true**:需要</li></ul>
+
+
+注：`该字段已经失效，请勿设置此参数。`
         :rtype: bool
         """
         return self._CertInfoCallback
@@ -969,7 +977,7 @@ class AutoSignConfig(AbstractModel):
     def VerifyChannels(self):
         """开通时候的身份验证方式, 取值为：
 <ul><li>**WEIXINAPP** : 微信人脸识别</li>
-<li>**INSIGHT** : 慧眼人脸认别</li>
+<li>**INSIGHT** : 慧眼人脸识别</li>
 <li>**TELECOM** : 运营商三要素验证</li></ul>
 注：
 <ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
@@ -987,6 +995,8 @@ class AutoSignConfig(AbstractModel):
         """设置用户开通自动签时是否绑定个人自动签账号许可。
 
 <ul><li><b>1</b>: (默认)不绑定自动签账号许可开通，开通后一直有效,   后续使用合同份额进行合同发起</li></ul>
+
+注：`该字段已经失效，请勿设置此参数。`
         :rtype: int
         """
         return self._LicenseType
@@ -2593,7 +2603,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
         :param _FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
 <ul>
 <li>若为个人参与方：ApproverType:"PERSON"</li>
-<li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，还需要传 OpenId、OrganizationOpenId。</li>
+<li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。（如果OrganizationOpenId对应子客企业已经认证激活，则可以省略OrganizationName参数）</li>
 </ul>
 
 注:
@@ -2671,7 +2681,7 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
         """批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
 <ul>
 <li>若为个人参与方：ApproverType:"PERSON"</li>
-<li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，还需要传 OpenId、OrganizationOpenId。</li>
+<li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。（如果OrganizationOpenId对应子客企业已经认证激活，则可以省略OrganizationName参数）</li>
 </ul>
 
 注:
@@ -4360,6 +4370,8 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
 <li>数字控件</li>
 <li>图片控件</li>
 <li>数据表格等填写控件</li></ul>
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
         :type Components: list of Component
         :param _Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
@@ -4548,6 +4560,8 @@ MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverM
 <li>数字控件</li>
 <li>图片控件</li>
 <li>数据表格等填写控件</li></ul>
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
         :rtype: list of Component
         """
         return self._Components
@@ -5721,7 +5735,7 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
         :type FlowId: str
         :param _FlowApproverInfos: 流程签署人列表，其中结构体的ApproverType必传。
 若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
-若为子客企业签署方则需传OpenId、OrganizationOpenId，OrganizationName 其他可不传。（如果对应OrganizationOpenId 子客已经认证激活了，则可以省去OrganizationName）
+若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName， 其他可不传。（如果对应OrganizationOpenId 子客已经认证激活了，则可以省去OrganizationName）
 
 此结构体和发起接口参与方结构体复用，除了上述参数外，可传递的参数有：
 1. RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。
@@ -5792,7 +5806,7 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
     def FlowApproverInfos(self):
         """流程签署人列表，其中结构体的ApproverType必传。
 若为个人签署方或saas企业签署方，则Name，Mobile必传。OrganizationName 传对应企业名称。
-若为子客企业签署方则需传OpenId、OrganizationOpenId，OrganizationName 其他可不传。（如果对应OrganizationOpenId 子客已经认证激活了，则可以省去OrganizationName）
+若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName， 其他可不传。（如果对应OrganizationOpenId 子客已经认证激活了，则可以省去OrganizationName）
 
 此结构体和发起接口参与方结构体复用，除了上述参数外，可传递的参数有：
 1. RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。
@@ -7104,7 +7118,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
         :type SealImageCompress: bool
         :param _Mobile: 手机号码；当需要开通自动签时，该参数必传
         :type Mobile: str
-        :param _EnableAutoSign: 此字段已废弃，请勿继续使用。
+        :param _EnableAutoSign: 该字段已不再使用
         :type EnableAutoSign: bool
         :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减	
         :type LicenseType: int
@@ -7238,7 +7252,7 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
 
     @property
     def EnableAutoSign(self):
-        """此字段已废弃，请勿继续使用。
+        """该字段已不再使用
         :rtype: bool
         """
         return self._EnableAutoSign
@@ -15959,6 +15973,9 @@ class CreateFlowOption(AbstractModel):
         :param _SignComponentConfig: 签署控件的配置信息，用在嵌入式发起的页面配置，包括 
  - 签署控件 是否默认展示日期.
         :type SignComponentConfig: :class:`tencentcloud.essbasic.v20210526.models.SignComponentConfig`
+        :param _ForbidEditWatermark: 是否禁止编辑（展示）水印控件属性
+<ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+        :type ForbidEditWatermark: bool
         """
         self._CanEditFlow = None
         self._HideShowFlowName = None
@@ -15970,6 +15987,7 @@ class CreateFlowOption(AbstractModel):
         self._ForbidEditFillComponent = None
         self._SkipUploadFile = None
         self._SignComponentConfig = None
+        self._ForbidEditWatermark = None
 
     @property
     def CanEditFlow(self):
@@ -16101,6 +16119,18 @@ class CreateFlowOption(AbstractModel):
     def SignComponentConfig(self, SignComponentConfig):
         self._SignComponentConfig = SignComponentConfig
 
+    @property
+    def ForbidEditWatermark(self):
+        """是否禁止编辑（展示）水印控件属性
+<ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+        :rtype: bool
+        """
+        return self._ForbidEditWatermark
+
+    @ForbidEditWatermark.setter
+    def ForbidEditWatermark(self, ForbidEditWatermark):
+        self._ForbidEditWatermark = ForbidEditWatermark
+
 
     def _deserialize(self, params):
         self._CanEditFlow = params.get("CanEditFlow")
@@ -16115,6 +16145,7 @@ class CreateFlowOption(AbstractModel):
         if params.get("SignComponentConfig") is not None:
             self._SignComponentConfig = SignComponentConfig()
             self._SignComponentConfig._deserialize(params.get("SignComponentConfig"))
+        self._ForbidEditWatermark = params.get("ForbidEditWatermark")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -20758,10 +20789,14 @@ class EmbedUrlOption(AbstractModel):
 
 注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**，
         :type SkipUploadFile: str
+        :param _ForbidEditWatermark: 是否禁止编辑（展示）水印控件属性
+<ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+        :type ForbidEditWatermark: bool
         """
         self._ShowFlowDetailComponent = None
         self._ShowTemplateComponent = None
         self._SkipUploadFile = None
+        self._ForbidEditWatermark = None
 
     @property
     def ShowFlowDetailComponent(self):
@@ -20807,11 +20842,24 @@ class EmbedUrlOption(AbstractModel):
     def SkipUploadFile(self, SkipUploadFile):
         self._SkipUploadFile = SkipUploadFile
 
+    @property
+    def ForbidEditWatermark(self):
+        """是否禁止编辑（展示）水印控件属性
+<ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+        :rtype: bool
+        """
+        return self._ForbidEditWatermark
+
+    @ForbidEditWatermark.setter
+    def ForbidEditWatermark(self, ForbidEditWatermark):
+        self._ForbidEditWatermark = ForbidEditWatermark
+
 
     def _deserialize(self, params):
         self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
         self._ShowTemplateComponent = params.get("ShowTemplateComponent")
         self._SkipUploadFile = params.get("SkipUploadFile")
+        self._ForbidEditWatermark = params.get("ForbidEditWatermark")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -21002,6 +21050,8 @@ class FillApproverInfo(AbstractModel):
 
         :type RecipientId: str
         :param _OpenId: 指定企业经办签署人OpenId
+
+注: `签署人OpenId未实名时，需要传入签署人姓名以及手机号码。`
         :type OpenId: str
         :param _ApproverName: 签署人姓名
         :type ApproverName: str
@@ -21060,6 +21110,8 @@ class FillApproverInfo(AbstractModel):
     @property
     def OpenId(self):
         """指定企业经办签署人OpenId
+
+注: `签署人OpenId未实名时，需要传入签署人姓名以及手机号码。`
         :rtype: str
         """
         return self._OpenId
@@ -21758,6 +21810,8 @@ class FlowApproverInfo(AbstractModel):
         :param _CallbackUrl: 签署完回调url，最大长度1000个字符
         :type CallbackUrl: str
         :param _SignComponents: 使用PDF文件直接发起合同时，签署人指定的签署控件；<br/>使用模板发起合同时，指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)
         :type SignComponents: list of Component
         :param _ComponentLimitType: 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
 
@@ -21854,8 +21908,9 @@ class FlowApproverInfo(AbstractModel):
 
 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件)
 
-
 注：`此参数仅在通过文件发起合同或者合同组时生效`
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
         :type Components: list of Component
         :param _Intention: <b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。
 
@@ -22074,6 +22129,8 @@ class FlowApproverInfo(AbstractModel):
     @property
     def SignComponents(self):
         """使用PDF文件直接发起合同时，签署人指定的签署控件；<br/>使用模板发起合同时，指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/91757a7f9188ccf3057a4a8979cf3f93.png)
         :rtype: list of Component
         """
         return self._SignComponents
@@ -22287,8 +22344,9 @@ class FlowApproverInfo(AbstractModel):
 
 具体使用说明可参考[为签署方指定填写控件](https://qian.tencent.cn/developers/partner/createFlowByFiles#为签署方指定填写控件)
 
-
 注：`此参数仅在通过文件发起合同或者合同组时生效`
+
+![image](https://qcloudimg.tencent-cloud.cn/raw/e004195ee4cb98a7f9bc12eb4a0a0b77.png)
         :rtype: list of Component
         """
         return self._Components
@@ -28880,6 +28938,8 @@ class SignUrlInfo(AbstractModel):
         :param _FlowGroupId: 合同组签署链接对应的合同组id
         :type FlowGroupId: str
         :param _SignQrcodeUrl: 二维码，在生成动态签署人跳转封面页链接时返回
+
+注：`此二维码下载链接有效期为5分钟，可下载二维码后本地保存。`
         :type SignQrcodeUrl: str
         """
         self._SignUrl = None
@@ -29052,6 +29112,8 @@ class SignUrlInfo(AbstractModel):
     @property
     def SignQrcodeUrl(self):
         """二维码，在生成动态签署人跳转封面页链接时返回
+
+注：`此二维码下载链接有效期为5分钟，可下载二维码后本地保存。`
         :rtype: str
         """
         return self._SignQrcodeUrl

{tencentcloud-sdk-python-essbasic-3.0.1381 → tencentcloud-sdk-python-essbasic-3.0.1387}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1381
+Version: 3.0.1387
 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.1387/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

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

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

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