tencentcloud-sdk-python-ess 3.0.1062__tar.gz → 3.0.1064__tar.gz

{tencentcloud-sdk-python-ess-3.0.1062 → tencentcloud-sdk-python-ess-3.0.1064}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.0.1062
+Version: 3.0.1064
 Summary: Tencent Cloud Ess SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

{tencentcloud-sdk-python-ess-3.0.1062 → tencentcloud-sdk-python-ess-3.0.1064}/setup.py

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

{tencentcloud-sdk-python-ess-3.0.1062 → tencentcloud-sdk-python-ess-3.0.1064}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1062'
+__version__ = '3.0.1064'

{tencentcloud-sdk-python-ess-3.0.1062 → tencentcloud-sdk-python-ess-3.0.1064}/tencentcloud/ess/v20201111/ess_client.py

@@ -1051,11 +1051,10 @@ class EssClient(AbstractClient):
         跳转到小程序的实现，参考微信官方文档（分为<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>
 
         注：
-        `1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署`
-
-        `2. 签署链接的有效期为90天，超过有效期链接不可用`
-
-        `3. 如果需跳转详情页（即PathType值为1）进行填写或签署合同，需指定签署方信息：姓名、手机号码、企业名称等，才能生成正确的跳转链接`
+        <ul><li>1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署</li>
+        <li>2. 签署链接的有效期为<font color="red">90天</font>，超过有效期链接不可用</li>
+        <li>3. 如果需跳转详情页（即PathType值为1）进行填写或签署合同，需指定签署方信息:姓名、手机号码、企业名称等，才能生成正确的跳转链接</li>
+        <li>4. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）</li></ul>
 
         其中小程序的原始Id如下，或者查看小程序信息自助获取。
 
@@ -1390,12 +1389,25 @@ class EssClient(AbstractClient):
 
     def DescribeExtendedServiceAuthInfos(self, request):
         """查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
-        1. 企业自动签
-        2. 企业与港澳台居民签署合同
-        3. 使用手机号验证签署方身份
-        4. 骑缝章
-        5. 批量签署能力
-        6. 拓宽签署方年龄限制
+
+        1. **企业自动签署**
+        2. **批量签署授权**
+        3. **企业与港澳台居民签署合同**
+        4. **拓宽签署方年龄限制**
+        5. **个人签署方仅校验手机号**
+        6. **隐藏合同经办人姓名**
+        7. **正楷临摹签名失败后更换其他签名类型**
+        8. **短信通知签署方**
+        9. **个人签署方手动签字**
+        10. **骑缝章**
+        11. **签署密码开通引导**
+
+
+        对应能力开通页面在Web控制台-更多-企业设置-拓展服务，如下图所示:
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/7d79746ecca1c5fe878a2ec36ed69c23.jpg)
+
+        注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId需要传递超管或者法人的UserId)
 
         :param request: Request instance for DescribeExtendedServiceAuthInfos.
         :type request: :class:`tencentcloud.ess.v20201111.models.DescribeExtendedServiceAuthInfosRequest`
@@ -1864,6 +1876,48 @@ class EssClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def ModifyExtendedService(self, request):
+        """管理企业扩展服务 ，企业经办人需要是企业超管或者法人。
+
+        跳转小程序的几种方式：主要是设置不同的EndPoint
+        1. 通过链接Url直接跳转到小程序，不需要返回
+        设置EndPoint为WEIXINAPP，得到链接打开即可。
+
+        2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
+        跳转到小程序的实现，参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
+        设置EndPoint为APP，得到path。
+
+        3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
+        跳转到小程序的实现，参考官方文档（分为<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>
+        设置EndPoint为APP，得到path。
+
+        4.其中小程序的原始Id如下，或者查看小程序信息自助获取。
+
+        | 小程序 | AppID | 原始ID |
+        | ------------ | ------------ | ------------ |
+        | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
+        | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
+
+        :param request: Request instance for ModifyExtendedService.
+        :type request: :class:`tencentcloud.ess.v20201111.models.ModifyExtendedServiceRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.ModifyExtendedServiceResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("ModifyExtendedService", params, headers=headers)
+            response = json.loads(body)
+            model = models.ModifyExtendedServiceResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def ModifyIntegrationDepartment(self, request):
         """此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。
 

{tencentcloud-sdk-python-ess-3.0.1062 → tencentcloud-sdk-python-ess-3.0.1064}/tencentcloud/ess/v20201111/models.py

@@ -2925,13 +2925,17 @@ class CreateBatchSignUrlResponse(AbstractModel):
         r"""
         :param _SignUrl: 批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。
 
-注: `非小程序和APP集成使用`
+注: 
+1. 非小程序和APP集成使用
+2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         :type SignUrl: str
         :param _ExpiredTime: 链接过期时间以 Unix 时间戳格式表示，默认生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
         :type ExpiredTime: int
         :param _MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
 
-注: `小程序和APP集成使用`
+注: 
+1. 小程序和APP集成使用
+2. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         :type MiniAppPath: str
         :param _RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
@@ -7990,6 +7994,9 @@ class CreateSchemeUrlResponse(AbstractModel):
 <ul><li>如果EndPoint是**APP**，得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
 <li>如果EndPoint是**HTTP**，得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`，点击后会跳转到腾讯电子签小程序进行签署</li>
 <li>如果EndPoint是**HTTP_SHORT_URL**，得到的链接类似于 `https://essurl.cn/2n**42Nd`，点击后会跳转到腾讯电子签小程序进行签署</li></ul>
+
+
+注： <font color="red">生成的链路后面不能再增加参数</font>
         :type SchemeUrl: str
         :param _SchemeQrcodeUrl: 二维码，在生成动态签署人跳转封面页链接时返回
         :type SchemeQrcodeUrl: str
@@ -10021,13 +10028,17 @@ class DescribeExtendedServiceAuthInfosRequest(AbstractModel):
         :param _ExtendServiceType: 要查询的扩展服务类型。
 默认为空，即查询当前支持的所有扩展服务信息。
 若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
-<ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
+<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>
+<li>BATCH_SIGN：批量签署</li>
 <li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
-<li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
+<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>
+<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>
+<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>
+<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>
+<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>
+<li>HIDE_ONE_KEY_SIGN：个人签署方手动签字</li>
 <li>PAGING_SEAL：骑缝章</li>
-<li>BATCH_SIGN：批量签署</li>
-<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li></ul>
-
+<li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li></ul>
         :type ExtendServiceType: str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -12544,17 +12555,25 @@ class ExtendAuthInfo(AbstractModel):
     def __init__(self):
         r"""
         :param _Type: 扩展服务的类型，可能是以下值：
-<ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
+<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>
+<li>BATCH_SIGN：批量签署</li>
 <li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
-<li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
+<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>
+<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>
+<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>
+<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>
+<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>
+<li>HIDE_ONE_KEY_SIGN：个人签署方手动签字</li>
 <li>PAGING_SEAL：骑缝章</li>
-<li>BATCH_SIGN：批量签署</li></ul>
+<li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li></ul>
         :type Type: str
         :param _Name: 扩展服务的名称
         :type Name: str
         :param _Status: 扩展服务的开通状态：
-ENABLE：开通
-DISABLE：未开通
+<ul>
+<li>ENABLE : 已开通</li>
+<li>DISABLE : 未开通</li>
+</ul>
         :type Status: str
         :param _OperatorUserId: 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
 注意：此字段可能返回 null，表示取不到有效值。
@@ -13539,27 +13558,24 @@ class FlowApproverUrlInfo(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _SignUrl: 签署短链接。</br>
+        :param _SignUrl: 签署短链接。
 注意:
-- 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
-- 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
-注意：此字段可能返回 null，表示取不到有效值。
+1. 该链接有效期为<b>30分钟</b>，同时需要注意保密，不要外泄给无关用户。
+2. 该链接不支持小程序嵌入，仅支持<b>移动端浏览器</b>打开。
+3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         :type SignUrl: str
         :param _ApproverType: 签署人类型。
 - **1**: 个人
-注意：此字段可能返回 null，表示取不到有效值。
         :type ApproverType: int
         :param _ApproverName: 签署人姓名。
-注意：此字段可能返回 null，表示取不到有效值。
         :type ApproverName: str
         :param _ApproverMobile: 签署人手机号。
-注意：此字段可能返回 null，表示取不到有效值。
         :type ApproverMobile: str
-        :param _LongUrl: 签署长链接。</br>
+        :param _LongUrl: 签署长链接。
 注意:
-- 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
-- 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
-注意：此字段可能返回 null，表示取不到有效值。
+1. 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
+2. 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
+3. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）
         :type LongUrl: str
         """
         self._SignUrl = None
@@ -15793,6 +15809,152 @@ class ModifyApplicationCallbackInfoResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class ModifyExtendedServiceRequest(AbstractModel):
+    """ModifyExtendedService请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Operator: 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _ServiceType: 要管理的拓展服务类型。
+<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>
+<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
+<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>
+<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>
+<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>
+<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>
+<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>
+<li>HIDE_ONE_KEY_SIGN：个人签署方手动签字</li>
+<li>PAGING_SEAL：骑缝章</li>
+<li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li></ul>
+        :type ServiceType: str
+        :param _Operate: 操作类型
+<ul>
+<li>OPEN : 开通</li>
+<li>CLOSE : 关闭</li>
+</ul>
+        :type Operate: str
+        :param _Agent: 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _Endpoint: 链接跳转类型，支持以下类型
+<ul>
+<li>WEIXINAPP : 短链直接跳转到电子签小程序  (默认值)</li>
+<li>APP : 第三方APP或小程序跳转电子签小程序</li>
+</ul>
+        :type Endpoint: str
+        """
+        self._Operator = None
+        self._ServiceType = None
+        self._Operate = None
+        self._Agent = None
+        self._Endpoint = None
+
+    @property
+    def Operator(self):
+        return self._Operator
+
+    @Operator.setter
+    def Operator(self, Operator):
+        self._Operator = Operator
+
+    @property
+    def ServiceType(self):
+        return self._ServiceType
+
+    @ServiceType.setter
+    def ServiceType(self, ServiceType):
+        self._ServiceType = ServiceType
+
+    @property
+    def Operate(self):
+        return self._Operate
+
+    @Operate.setter
+    def Operate(self, Operate):
+        self._Operate = Operate
+
+    @property
+    def Agent(self):
+        return self._Agent
+
+    @Agent.setter
+    def Agent(self, Agent):
+        self._Agent = Agent
+
+    @property
+    def Endpoint(self):
+        return self._Endpoint
+
+    @Endpoint.setter
+    def Endpoint(self, Endpoint):
+        self._Endpoint = Endpoint
+
+
+    def _deserialize(self, params):
+        if params.get("Operator") is not None:
+            self._Operator = UserInfo()
+            self._Operator._deserialize(params.get("Operator"))
+        self._ServiceType = params.get("ServiceType")
+        self._Operate = params.get("Operate")
+        if params.get("Agent") is not None:
+            self._Agent = Agent()
+            self._Agent._deserialize(params.get("Agent"))
+        self._Endpoint = params.get("Endpoint")
+        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 ModifyExtendedServiceResponse(AbstractModel):
+    """ModifyExtendedService返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _OperateUrl: 操作跳转链接，有效期24小时
+若操作时没有返回跳转链接，表示无需跳转操作，此时会直接开通/关闭服务。
+
+当操作类型是 OPEN 且 扩展服务类型是  OPEN_SERVER_SIGN 或者 OVERSEA_SIGN 时返回操作链接，
+返回的链接当前操作人（超管或法人）点击链接完成服务开通操作。
+        :type OperateUrl: str
+        :param _RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._OperateUrl = None
+        self._RequestId = None
+
+    @property
+    def OperateUrl(self):
+        return self._OperateUrl
+
+    @OperateUrl.setter
+    def OperateUrl(self, OperateUrl):
+        self._OperateUrl = OperateUrl
+
+    @property
+    def RequestId(self):
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._OperateUrl = params.get("OperateUrl")
+        self._RequestId = params.get("RequestId")
+
+
 class ModifyIntegrationDepartmentRequest(AbstractModel):
     """ModifyIntegrationDepartment请求参数结构体
 

{tencentcloud-sdk-python-ess-3.0.1062 → tencentcloud-sdk-python-ess-3.0.1064}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.0.1062
+Version: 3.0.1064
 Summary: Tencent Cloud Ess SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

tencentcloud-sdk-python-ess-3.0.1064/tencentcloud_sdk_python_ess.egg-info/requires.txt

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

tencentcloud-sdk-python-ess-3.0.1062/tencentcloud_sdk_python_ess.egg-info/requires.txt

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