tencentcloud-sdk-python-essbasic 3.0.1117__py2.py3-none-any.whl → 3.0.1125__py2.py3-none-any.whl

tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1117'
+__version__ = '3.0.1125'

tencentcloud/essbasic/v20210526/models.py

@@ -242,8 +242,10 @@ class ApproverOption(AbstractModel):
         :type HideOneKeySign: bool
         :param _FillType: 签署人信息补充类型，默认无需补充。
 
-<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li>
-</ul>
+<ul><li> **1** : ( 动态签署人（可发起合同后再补充签署人信息）注：`企业自动签不支持动态补充`</li></ul>
+
+注：
+`使用动态签署人能力前，需登陆腾讯电子签控制台打开服务开关`
         :type FillType: int
         :param _FlowReadLimit: 签署人阅读合同限制参数
  <br/>取值：
@@ -612,6 +614,17 @@ class AutoSignConfig(AbstractModel):
 <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
 <li>**1**: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起</li></ul>
         :type LicenseType: int
+        :param _JumpUrl: 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
+
+注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
+
+跳转场景：
+<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>
+<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
+
+成功结果返回：
+若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，比如 qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
+        :type JumpUrl: str
         """
         self._UserInfo = None
         self._CertInfoCallback = None
@@ -620,6 +633,7 @@ class AutoSignConfig(AbstractModel):
         self._CallbackUrl = None
         self._VerifyChannels = None
         self._LicenseType = None
+        self._JumpUrl = None
 
     @property
     def UserInfo(self):
@@ -677,6 +691,14 @@ class AutoSignConfig(AbstractModel):
     def LicenseType(self, LicenseType):
         self._LicenseType = LicenseType
 
+    @property
+    def JumpUrl(self):
+        return self._JumpUrl
+
+    @JumpUrl.setter
+    def JumpUrl(self, JumpUrl):
+        self._JumpUrl = JumpUrl
+
 
     def _deserialize(self, params):
         if params.get("UserInfo") is not None:
@@ -688,6 +710,7 @@ class AutoSignConfig(AbstractModel):
         self._CallbackUrl = params.get("CallbackUrl")
         self._VerifyChannels = params.get("VerifyChannels")
         self._LicenseType = params.get("LicenseType")
+        self._JumpUrl = params.get("JumpUrl")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -5477,6 +5500,8 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
         :type NotifyAddress: str
         :param _ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
         :type ExpiredTime: int
+        :param _UserData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。 
+        :type UserData: str
         """
         self._Agent = None
         self._SceneKey = None
@@ -5486,6 +5511,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
         self._NotifyType = None
         self._NotifyAddress = None
         self._ExpiredTime = None
+        self._UserData = None
 
     @property
     def Agent(self):
@@ -5551,6 +5577,14 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
     def ExpiredTime(self, ExpiredTime):
         self._ExpiredTime = ExpiredTime
 
+    @property
+    def UserData(self):
+        return self._UserData
+
+    @UserData.setter
+    def UserData(self, UserData):
+        self._UserData = UserData
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -5567,6 +5601,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
         self._NotifyType = params.get("NotifyType")
         self._NotifyAddress = params.get("NotifyAddress")
         self._ExpiredTime = params.get("ExpiredTime")
+        self._UserData = params.get("UserData")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -8977,15 +9012,13 @@ class Component(AbstractModel):
 <ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
 <li> <b>SIGN_DATE</b> : 签署日期控件；</li>
 <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
-<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件（使用文件发起暂不支持此类型）；</li>
 <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
 <li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>
 <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
 
 * 个人方
 <ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>
-<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
-<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件（使用文件发起暂不支持此类型）；</li></ul>
+<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li></ul>
  
 注：` 表单域的控件不能作为印章和签名控件`
         :type ComponentType: str
@@ -9930,6 +9963,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
 
 注：`该姓名需要和Agent.ProxyOperator.OpenId相匹配,  当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效`
         :type ProxyOperatorName: str
+        :param _ProxyOperatorMobile: 子客企业员工的手机码,  支持国内手机号11位数字(无需加+86前缀或其他字符)。注：`该手机号需要和Agent.ProxyOperator.OpenId相匹配,  当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效`
+        :type ProxyOperatorMobile: str
         :param _Module: Web控制台登录后进入的功能模块,  支持的模块包括：
 <ul>
 <li> **空值** :(默认)企业中心模块</li>
@@ -9987,6 +10022,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
         self._ProxyOrganizationName = None
         self._UniformSocialCreditCode = None
         self._ProxyOperatorName = None
+        self._ProxyOperatorMobile = None
         self._Module = None
         self._ModuleId = None
         self._MenuStatus = None
@@ -10029,6 +10065,14 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
     def ProxyOperatorName(self, ProxyOperatorName):
         self._ProxyOperatorName = ProxyOperatorName
 
+    @property
+    def ProxyOperatorMobile(self):
+        return self._ProxyOperatorMobile
+
+    @ProxyOperatorMobile.setter
+    def ProxyOperatorMobile(self, ProxyOperatorMobile):
+        self._ProxyOperatorMobile = ProxyOperatorMobile
+
     @property
     def Module(self):
         return self._Module
@@ -10113,6 +10157,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
         self._ProxyOrganizationName = params.get("ProxyOrganizationName")
         self._UniformSocialCreditCode = params.get("UniformSocialCreditCode")
         self._ProxyOperatorName = params.get("ProxyOperatorName")
+        self._ProxyOperatorMobile = params.get("ProxyOperatorMobile")
         self._Module = params.get("Module")
         self._ModuleId = params.get("ModuleId")
         self._MenuStatus = params.get("MenuStatus")
@@ -11158,7 +11203,13 @@ class CreateSignUrlsRequest(AbstractModel):
 注： 
 如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）
         :type OpenId: str
-        :param _AutoJumpBack: Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序
+        :param _AutoJumpBack: 签署完成后是否自动回跳
+<ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
+
+注: 
+1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
+2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
+3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font> 
         :type AutoJumpBack: bool
         :param _JumpUrl: 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
         :type JumpUrl: str
@@ -14006,11 +14057,16 @@ class FlowApproverInfo(AbstractModel):
         :type CallbackUrl: str
         :param _SignComponents: 使用PDF文件直接发起合同时，签署人指定的签署控件；<br/>使用模板发起合同时，指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件，ComponentValue为印章ID。
         :type SignComponents: list of Component
-        :param _ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式
-	HANDWRITE – 手写签名
-	OCR_ESIGN -- AI智能识别手写签名
-	ESIGN -- 个人印章类型
-	SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
+        :param _ComponentLimitType: 当签署方控件类型为 <b>SIGN_SIGNATURE</b> 时，可以指定签署方签名方式。如果不指定，签署人可以使用所有的签名类型，可指定的签名类型包括：
+
+<ul><li> <b>HANDWRITE</b> :手写签名。</li>
+<li> <b>OCR_ESIGN</b> :AI智能识别手写签名。</li>
+<li> <b>ESIGN</b> :个人印章类型。</li>
+<li> <b>IMG_ESIGN</b>  : 图片印章。该类型支持用户在签署将上传的PNG格式的图片作为签名。</li>
+<li> <b>SYSTEM_ESIGN</b> :系统签名。该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署。</li></ul>
+
+各种签名的样式可以参考下图：
+![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
         :type ComponentLimitType: list of str
         :param _PreReadTime: 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
 
@@ -14048,7 +14104,7 @@ class FlowApproverInfo(AbstractModel):
 <li> **2** :签署密码</li>
 <li> **3** :运营商三要素</li></ul>
 
-默认为1(人脸认证 ),2(签署密码)
+默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
 
 注: 
 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
@@ -18111,6 +18167,8 @@ class RegistrationOrganizationInfo(AbstractModel):
         :type AdminIdCardNumber: str
         :param _BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
         :type BusinessLicense: str
+        :param _PowerOfAttorneys: 授权书(PNG或JPG或PDF) base64格式, 大小不超过8M
+        :type PowerOfAttorneys: list of str
         """
         self._OrganizationName = None
         self._OrganizationOpenId = None
@@ -18124,6 +18182,7 @@ class RegistrationOrganizationInfo(AbstractModel):
         self._AdminIdCardType = None
         self._AdminIdCardNumber = None
         self._BusinessLicense = None
+        self._PowerOfAttorneys = None
 
     @property
     def OrganizationName(self):
@@ -18221,6 +18280,14 @@ class RegistrationOrganizationInfo(AbstractModel):
     def BusinessLicense(self, BusinessLicense):
         self._BusinessLicense = BusinessLicense
 
+    @property
+    def PowerOfAttorneys(self):
+        return self._PowerOfAttorneys
+
+    @PowerOfAttorneys.setter
+    def PowerOfAttorneys(self, PowerOfAttorneys):
+        self._PowerOfAttorneys = PowerOfAttorneys
+
 
     def _deserialize(self, params):
         self._OrganizationName = params.get("OrganizationName")
@@ -18235,6 +18302,7 @@ class RegistrationOrganizationInfo(AbstractModel):
         self._AdminIdCardType = params.get("AdminIdCardType")
         self._AdminIdCardNumber = params.get("AdminIdCardNumber")
         self._BusinessLicense = params.get("BusinessLicense")
+        self._PowerOfAttorneys = params.get("PowerOfAttorneys")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]

{tencentcloud_sdk_python_essbasic-3.0.1117.dist-info → tencentcloud_sdk_python_essbasic-3.0.1125.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1117
+Version: 3.0.1125
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common (==3.0.1117)
+Requires-Dist: tencentcloud-sdk-python-common (==3.0.1125)
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_essbasic-3.0.1117.dist-info → tencentcloud_sdk_python_essbasic-3.0.1125.dist-info}/RECORD

@@ -1,4 +1,4 @@
-tencentcloud/__init__.py,sha256=3EgA4QT0lseHrC7aWrHE6YdJ2AUrWlHjZ3UzbTOu91Y,631
+tencentcloud/__init__.py,sha256=sDznTSZAJI8SnhZI2P-GeQHKTik28E4oOWl4QGIz91Y,631
 tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/errorcodes.py,sha256=cZPs0vLmArRFQoZqxM4alb0WeBF9f0V0IHmt65dUdxs,5392
@@ -7,8 +7,8 @@ tencentcloud/essbasic/v20201222/models.py,sha256=Q2E6jmVT1emRziwRN-qj8XpdzpxvqqH
 tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20210526/errorcodes.py,sha256=L1_0J4AOPtBTgtVqauXq0aVisXRe03bOUWFB0QCnXRs,18219
 tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=KlAe4Fa-C4iP39RxEzIXlInSDTU3TvDT-0rwXm5LwBQ,133628
-tencentcloud/essbasic/v20210526/models.py,sha256=I2hqKJJ7CvmqAsKoHaVM1-ZimkjJJg8ca7Y796b1YMk,727542
-tencentcloud_sdk_python_essbasic-3.0.1117.dist-info/METADATA,sha256=YGyM8kbBn2wgYQ21aDPEfs83Ky-fQiGLfPo0dj16VeA,1517
-tencentcloud_sdk_python_essbasic-3.0.1117.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-tencentcloud_sdk_python_essbasic-3.0.1117.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
-tencentcloud_sdk_python_essbasic-3.0.1117.dist-info/RECORD,,
+tencentcloud/essbasic/v20210526/models.py,sha256=RmJj4Ey-ecbhw1gRTWFeOXB0L7kl7F8TDM1xNEFcU5A,731670
+tencentcloud_sdk_python_essbasic-3.0.1125.dist-info/METADATA,sha256=rejShMhtOKQJ-GJWwiPu_c71Ad1_x_piGHMY1qCy_hE,1517
+tencentcloud_sdk_python_essbasic-3.0.1125.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
+tencentcloud_sdk_python_essbasic-3.0.1125.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
+tencentcloud_sdk_python_essbasic-3.0.1125.dist-info/RECORD,,