tencentcloud-sdk-python-ess 3.0.1063__tar.gz → 3.0.1076__tar.gz

{tencentcloud-sdk-python-ess-3.0.1063 → tencentcloud-sdk-python-ess-3.0.1076}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.0.1063
+Version: 3.0.1076
 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.1063 → tencentcloud-sdk-python-ess-3.0.1076}/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.1063"],
+    install_requires=["tencentcloud-sdk-python-common==3.0.1076"],
     version=tencentcloud.__version__,
     description='Tencent Cloud Ess SDK for Python',
     long_description=open('README.rst').read(),

{tencentcloud-sdk-python-ess-3.0.1063 → tencentcloud-sdk-python-ess-3.0.1076}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1063'
+__version__ = '3.0.1076'

{tencentcloud-sdk-python-ess-3.0.1063 → tencentcloud-sdk-python-ess-3.0.1076}/tencentcloud/ess/v20201111/ess_client.py

@@ -77,9 +77,9 @@ class EssClient(AbstractClient):
 
 
     def CancelMultiFlowSignQRCode(self, request):
-        """此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
-        该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
-        如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
+        """此接口（CancelMultiFlowSignQRCode）用于废除一码多签签署码。
+        该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
+        如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。
 
         :param request: Request instance for CancelMultiFlowSignQRCode.
         :type request: :class:`tencentcloud.ess.v20201111.models.CancelMultiFlowSignQRCodeRequest`
@@ -678,15 +678,14 @@ class EssClient(AbstractClient):
 
 
     def CreateFlowSignUrl(self, request):
-        """该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
+        """该接口用于发起合同后，生成用户的签署链接 <br/>
 
         **注意**
-        1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
-        2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，**不支持填写控件** 。
-        3. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
-        4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
+        1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件，**不支持填写控件** 。
+        2. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
+        3. 该接口返回的签署链接适用于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>。
-        5. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        4. 因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 CreateFlowSignUrl.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignUrlRequest`
@@ -732,7 +731,36 @@ class EssClient(AbstractClient):
 
 
     def CreateIntegrationEmployees(self, request):
-        """此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。
+        """此接口（CreateIntegrationEmployees）用于创建企业员工。
+        支持以下场景
+        <table style="border-collapse: collapse; width: 100%;" border="1">
+        <tbody>
+        <tr>
+        <td style="width: 25%;">生成端</td>
+        <td style="width: 25%;">入参</td>
+        <td style="width: 25%;">提醒方式</td>
+        </tr>
+        <tr>
+        <td style="width: 25%;">普通saas员工</td>
+        <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
+        <td style="width: 25%;">短信</td>
+        </tr>
+        <tr>
+        <td style="width: 25%;">企微员工</td>
+        <td style="width: 25%;">不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内</td>
+        <td style="width: 25%;">企微内部实名消息</td>
+        </tr>
+        <tr>
+        <td style="width: 25%;">H5端 saas员工</td>
+        <td style="width: 25%;">传递 InvitationNotifyType = H5，不支持企微</td>
+        <td style="width: 25%;">生成H5链接</td>
+        </tr>
+        </tbody>
+        </table>
+        注意：
+
+        - <b>若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。</b>
+        - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
 
         :param request: Request instance for CreateIntegrationEmployees.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationEmployeesRequest`
@@ -811,7 +839,7 @@ class EssClient(AbstractClient):
 
 
     def CreateMultiFlowSignQRCode(self, request):
-        """此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+        """此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。
 
         **适用场景**:
         签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
@@ -821,11 +849,11 @@ class EssClient(AbstractClient):
             - 模板中配置的签署顺序是无序
             - B端企业的签署方式是静默签署
             - B端企业是非首位签署
-        2. 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+        2. 通过一码多签签署码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
         ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
-        3. 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
+        3. 用户通过一码多签签署码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
 
-        二维码的样式如下图:
+        签署码的样式如下图:
         ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
 
         :param request: Request instance for CreateMultiFlowSignQRCode.
@@ -1389,12 +1417,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`
@@ -1863,6 +1904,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和部门序号等信息。
 
@@ -1975,8 +2058,35 @@ class EssClient(AbstractClient):
 
 
     def UpdateIntegrationEmployees(self, request):
-        """更新员工信息(姓名，手机号，邮件、部门)，用户实名后无法更改姓名与手机号。
-        可进行批量操作，Employees中的userID与openID二选一必填
+        """此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。
+        修改手机号的时候,支持以下场景进行提醒通知
+        <table style="border-collapse: collapse; width: 100%;" border="1">
+        <tbody>
+        <tr>
+        <td style="width: 25%;">生成端</td>
+        <td style="width: 25%;">入参</td>
+        <td style="width: 25%;">提醒方式</td>
+        </tr>
+        <tr>
+        <td style="width: 25%;">普通saas员工</td>
+        <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
+        <td style="width: 25%;">短信</td>
+        </tr>
+        <tr>
+        <td style="width: 25%;">企微员工</td>
+        <td style="width: 25%;">不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内</td>
+        <td style="width: 25%;">企微内部实名消息</td>
+        </tr>
+        <tr>
+        <td style="width: 25%;">H5端 saas员工</td>
+        <td style="width: 25%;">传递 InvitationNotifyType = H5，不支持企微</td>
+        <td style="width: 25%;">生成H5链接</td>
+        </tr>
+        </tbody>
+        </table>
+        注意：
+
+        - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
 
         :param request: Request instance for UpdateIntegrationEmployees.
         :type request: :class:`tencentcloud.ess.v20201111.models.UpdateIntegrationEmployeesRequest`

{tencentcloud-sdk-python-ess-3.0.1063 → tencentcloud-sdk-python-ess-3.0.1076}/tencentcloud/ess/v20201111/models.py

@@ -1608,7 +1608,7 @@ class CancelMultiFlowSignQRCodeRequest(AbstractModel):
         :param _Operator: 执行本接口操作的员工信息。
 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
-        :param _QrCodeId: 二维码ID，为32位字符串。
+        :param _QrCodeId: 需要取消的签署码ID，为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode/)返回
         :type QrCodeId: str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -1905,8 +1905,9 @@ class Component(AbstractModel):
 <li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
 <li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>
 
-**如果是SignComponent签署控件类型，则可选的字段为**
-
+**如果是SignComponent签署控件类型，
+需要根据签署人的类型可选的字段为**
+* 企业方
 <ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>
 <li> <b>SIGN_DATE</b> : 签署日期控件；</li>
 <li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>
@@ -1914,6 +1915,12 @@ class Component(AbstractModel):
 <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>
+ 
 注：` 表单域的控件不能作为印章和签名控件`
         :type ComponentType: str
         :param _ComponentHeight: **在绝对定位方式和关键字定位方式下**，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。
@@ -2006,6 +2013,12 @@ class Component(AbstractModel):
 <font color="red">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：
 <ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>
 <b>参数样例</b>：` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
+
+
+<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
+<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
+场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。
+<b>参数样例</b>：` "{"IgnoreKeywordError":1}"`
         :type ComponentExtra: str
         :param _IsFormType: **在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**
 注意：此字段可能返回 null，表示取不到有效值。
@@ -5556,29 +5569,37 @@ class CreateFlowSignUrlRequest(AbstractModel):
 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
         :type FlowId: str
-        :param _FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，其他可不传，
-
-注:
-`1. ApproverType目前只支持个人类型的签署人。`
-`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
-        :type FlowApproverInfos: list of FlowCreateApprover
         :param _Operator: 执行本接口操作的员工信息。
 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。
+
+注:
+`1. 签署人只能有手写签名、时间类型和印章类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
+        :type FlowApproverInfos: list of FlowCreateApprover
         :param _Organization: 机构信息，暂未开放
         :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
         :param _JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
         :type JumpUrl: str
+        :param _UrlType: 链接类型，支持指定以下类型
+<ul><li>0 : 签署链接 (默认值)</li>
+<li>1 : 预览链接</li></ul>
+注:
+`1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。`
+`2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`
+        :type UrlType: int
         """
         self._FlowId = None
-        self._FlowApproverInfos = None
         self._Operator = None
         self._Agent = None
+        self._FlowApproverInfos = None
         self._Organization = None
         self._JumpUrl = None
+        self._UrlType = None
 
     @property
     def FlowId(self):
@@ -5588,14 +5609,6 @@ class CreateFlowSignUrlRequest(AbstractModel):
     def FlowId(self, FlowId):
         self._FlowId = FlowId
 
-    @property
-    def FlowApproverInfos(self):
-        return self._FlowApproverInfos
-
-    @FlowApproverInfos.setter
-    def FlowApproverInfos(self, FlowApproverInfos):
-        self._FlowApproverInfos = FlowApproverInfos
-
     @property
     def Operator(self):
         return self._Operator
@@ -5612,6 +5625,14 @@ class CreateFlowSignUrlRequest(AbstractModel):
     def Agent(self, Agent):
         self._Agent = Agent
 
+    @property
+    def FlowApproverInfos(self):
+        return self._FlowApproverInfos
+
+    @FlowApproverInfos.setter
+    def FlowApproverInfos(self, FlowApproverInfos):
+        self._FlowApproverInfos = FlowApproverInfos
+
     @property
     def Organization(self):
         warnings.warn("parameter `Organization` is deprecated", DeprecationWarning) 
@@ -5632,25 +5653,34 @@ class CreateFlowSignUrlRequest(AbstractModel):
     def JumpUrl(self, JumpUrl):
         self._JumpUrl = JumpUrl
 
+    @property
+    def UrlType(self):
+        return self._UrlType
+
+    @UrlType.setter
+    def UrlType(self, UrlType):
+        self._UrlType = UrlType
+
 
     def _deserialize(self, params):
         self._FlowId = params.get("FlowId")
-        if params.get("FlowApproverInfos") is not None:
-            self._FlowApproverInfos = []
-            for item in params.get("FlowApproverInfos"):
-                obj = FlowCreateApprover()
-                obj._deserialize(item)
-                self._FlowApproverInfos.append(obj)
         if params.get("Operator") is not None:
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
         if params.get("Agent") is not None:
             self._Agent = Agent()
             self._Agent._deserialize(params.get("Agent"))
+        if params.get("FlowApproverInfos") is not None:
+            self._FlowApproverInfos = []
+            for item in params.get("FlowApproverInfos"):
+                obj = FlowCreateApprover()
+                obj._deserialize(item)
+                self._FlowApproverInfos.append(obj)
         if params.get("Organization") is not None:
             self._Organization = OrganizationInfo()
             self._Organization._deserialize(params.get("Organization"))
         self._JumpUrl = params.get("JumpUrl")
+        self._UrlType = params.get("UrlType")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -5869,10 +5899,21 @@ class CreateIntegrationEmployeesRequest(AbstractModel):
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _InvitationNotifyType: 员工邀请方式
+如果是来自H5的，参数需要传递H5
+短信或者企微 请传递SMS，或者不传递
+        :type InvitationNotifyType: str
+        :param _JumpUrl: 回跳地址，
+在认证成功之后，进行回跳，请保证回跳地址的可用性。
+使用前请联系对接的客户经理沟通，提供回跳地址的域名，进行域名配置
+
+        :type JumpUrl: str
         """
         self._Operator = None
         self._Employees = None
         self._Agent = None
+        self._InvitationNotifyType = None
+        self._JumpUrl = None
 
     @property
     def Operator(self):
@@ -5898,6 +5939,22 @@ class CreateIntegrationEmployeesRequest(AbstractModel):
     def Agent(self, Agent):
         self._Agent = Agent
 
+    @property
+    def InvitationNotifyType(self):
+        return self._InvitationNotifyType
+
+    @InvitationNotifyType.setter
+    def InvitationNotifyType(self, InvitationNotifyType):
+        self._InvitationNotifyType = InvitationNotifyType
+
+    @property
+    def JumpUrl(self):
+        return self._JumpUrl
+
+    @JumpUrl.setter
+    def JumpUrl(self, JumpUrl):
+        self._JumpUrl = JumpUrl
+
 
     def _deserialize(self, params):
         if params.get("Operator") is not None:
@@ -5912,6 +5969,8 @@ class CreateIntegrationEmployeesRequest(AbstractModel):
         if params.get("Agent") is not None:
             self._Agent = Agent()
             self._Agent._deserialize(params.get("Agent"))
+        self._InvitationNotifyType = params.get("InvitationNotifyType")
+        self._JumpUrl = params.get("JumpUrl")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -6442,9 +6501,9 @@ class CreateMultiFlowSignQRCodeResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _QrCode: 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
+        :param _QrCode: 一码多签签署码的基本信息，用户可扫描该二维码进行签署操作。
         :type QrCode: :class:`tencentcloud.ess.v20201111.models.SignQrCode`
-        :param _SignUrls: 流程签署二维码的签署信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
+        :param _SignUrls: 一码多签签署码的链接信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
         :type SignUrls: :class:`tencentcloud.ess.v20201111.models.SignUrl`
         :param _RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
@@ -6978,12 +7037,17 @@ class CreatePrepareFlowRequest(AbstractModel):
         :param _ResourceId: 资源id，与ResourceType相对应，取值范围：
 <ul>
 <li>文件Id（通过UploadFiles获取文件资源Id）</li>
-<li>模板Id</li>
+<li>模板Id（通过控制台创建模板后获取模板Id）</li>
 </ul>
+注意：需要同时设置 ResourceType 参数指定资源类型
         :type ResourceId: str
         :param _FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
 
         :type FlowName: str
+        :param _ResourceType: 资源类型，取值有：
+<ul><li> **1**：模板</li>
+<li> **2**：文件（默认值）</li></ul>
+        :type ResourceType: int
         :param _Unordered: 合同流程的签署顺序类型：
 <ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
 <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
@@ -7006,10 +7070,6 @@ class CreatePrepareFlowRequest(AbstractModel):
 <ul><li> **OPEN**：开启（默认值）</li>
 <li> **CLOSE**：关闭</li></ul>
         :type IntelligentStatus: str
-        :param _ResourceType: 资源类型，取值有：
-<ul><li> **1**：模板</li>
-<li> **2**：文件（默认值）</li></ul>
-        :type ResourceType: int
         :param _Components: 该字段已废弃，请使用InitiatorComponents
         :type Components: :class:`tencentcloud.ess.v20201111.models.Component`
         :param _FlowOption: 发起合同个性化参数
@@ -7050,13 +7110,13 @@ class CreatePrepareFlowRequest(AbstractModel):
         self._Operator = None
         self._ResourceId = None
         self._FlowName = None
+        self._ResourceType = None
         self._Unordered = None
         self._Deadline = None
         self._UserFlowTypeId = None
         self._FlowType = None
         self._Approvers = None
         self._IntelligentStatus = None
-        self._ResourceType = None
         self._Components = None
         self._FlowOption = None
         self._NeedSignReview = None
@@ -7091,6 +7151,14 @@ class CreatePrepareFlowRequest(AbstractModel):
     def FlowName(self, FlowName):
         self._FlowName = FlowName
 
+    @property
+    def ResourceType(self):
+        return self._ResourceType
+
+    @ResourceType.setter
+    def ResourceType(self, ResourceType):
+        self._ResourceType = ResourceType
+
     @property
     def Unordered(self):
         return self._Unordered
@@ -7139,14 +7207,6 @@ class CreatePrepareFlowRequest(AbstractModel):
     def IntelligentStatus(self, IntelligentStatus):
         self._IntelligentStatus = IntelligentStatus
 
-    @property
-    def ResourceType(self):
-        return self._ResourceType
-
-    @ResourceType.setter
-    def ResourceType(self, ResourceType):
-        self._ResourceType = ResourceType
-
     @property
     def Components(self):
         return self._Components
@@ -7226,6 +7286,7 @@ class CreatePrepareFlowRequest(AbstractModel):
             self._Operator._deserialize(params.get("Operator"))
         self._ResourceId = params.get("ResourceId")
         self._FlowName = params.get("FlowName")
+        self._ResourceType = params.get("ResourceType")
         self._Unordered = params.get("Unordered")
         self._Deadline = params.get("Deadline")
         self._UserFlowTypeId = params.get("UserFlowTypeId")
@@ -7237,7 +7298,6 @@ class CreatePrepareFlowRequest(AbstractModel):
                 obj._deserialize(item)
                 self._Approvers.append(obj)
         self._IntelligentStatus = params.get("IntelligentStatus")
-        self._ResourceType = params.get("ResourceType")
         if params.get("Components") is not None:
             self._Components = Component()
             self._Components._deserialize(params.get("Components"))
@@ -10028,13 +10088,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）为必填项。
@@ -11430,7 +11494,12 @@ class DescribeIntegrationRolesRequest(AbstractModel):
   </li>
 </ul>
         :type Filters: list of Filter
-        :param _Offset: 指定分页返回第几页的数据，如果不传默认返回第一页。页码从 0 开始，即首页为 0，最大2000。
+        :param _Offset: OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0,最大2000。
+分页参数, 需要limit, offset 配合使用
+例如:
+您希望得到第三页的数据, 且每页限制最多10条
+您可以使用 LIMIT 10 OFFSET 20
+
         :type Offset: int
         """
         self._Operator = None
@@ -11512,7 +11581,11 @@ class DescribeIntegrationRolesResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Offset: 指定分页返回的页码。页码从0开始，最大为2000。
+        :param _Offset: OFFSET 用于指定查询结果的偏移量，如果不传默认偏移为0, 最大为2000
+分页参数, 需要limit, offset 配合使用
+例如:
+您希望得到第三页的数据, 且每页限制最多10条
+您可以使用 LIMIT 10 OFFSET 20
         :type Offset: int
         :param _Limit: 指定分页每页返回的数据条数，单页最大支持 200。
         :type Limit: int
@@ -12551,17 +12624,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，表示取不到有效值。
@@ -15797,6 +15878,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请求参数结构体
 
@@ -18118,7 +18345,8 @@ class StartFlowResponse(AbstractModel):
 
 
 class SuccessCreateStaffData(AbstractModel):
-    """创建员工的成功数据
+    """创建员工成功返回的信息
+    支持saas/企微/H5端进行加入。
 
     """
 
@@ -18135,12 +18363,17 @@ class SuccessCreateStaffData(AbstractModel):
         :type Note: str
         :param _WeworkOpenId: 传入的企微账号id
         :type WeworkOpenId: str
+        :param _Url: H5端员工加入\实名链接
+
+只有入参 InvitationNotifyType = H5的时候才会进行返回。
+        :type Url: str
         """
         self._DisplayName = None
         self._Mobile = None
         self._UserId = None
         self._Note = None
         self._WeworkOpenId = None
+        self._Url = None
 
     @property
     def DisplayName(self):
@@ -18182,6 +18415,14 @@ class SuccessCreateStaffData(AbstractModel):
     def WeworkOpenId(self, WeworkOpenId):
         self._WeworkOpenId = WeworkOpenId
 
+    @property
+    def Url(self):
+        return self._Url
+
+    @Url.setter
+    def Url(self, Url):
+        self._Url = Url
+
 
     def _deserialize(self, params):
         self._DisplayName = params.get("DisplayName")
@@ -18189,6 +18430,7 @@ class SuccessCreateStaffData(AbstractModel):
         self._UserId = params.get("UserId")
         self._Note = params.get("Note")
         self._WeworkOpenId = params.get("WeworkOpenId")
+        self._Url = params.get("Url")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -18257,7 +18499,9 @@ class SuccessDeleteStaffData(AbstractModel):
 
 
 class SuccessUpdateStaffData(AbstractModel):
-    """更新员工信息成功返回的数据信息
+    """更新员工信息成功返回的数据信息， 仅支持未实名的用户进行更新
+    会通过短信、企微消息或者H5Url 链接
+    如果是通过H5邀请加入的方式，会返回H5 链接
 
     """
 
@@ -18270,10 +18514,15 @@ class SuccessUpdateStaffData(AbstractModel):
         :param _UserId: 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
 可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
         :type UserId: str
+        :param _Url: H5端员工实名链接
+
+只有入参 InvitationNotifyType = H5的时候才会进行返回。
+        :type Url: str
         """
         self._DisplayName = None
         self._Mobile = None
         self._UserId = None
+        self._Url = None
 
     @property
     def DisplayName(self):
@@ -18299,11 +18548,20 @@ class SuccessUpdateStaffData(AbstractModel):
     def UserId(self, UserId):
         self._UserId = UserId
 
+    @property
+    def Url(self):
+        return self._Url
+
+    @Url.setter
+    def Url(self, Url):
+        self._Url = Url
+
 
     def _deserialize(self, params):
         self._DisplayName = params.get("DisplayName")
         self._Mobile = params.get("Mobile")
         self._UserId = params.get("UserId")
+        self._Url = params.get("Url")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -18806,10 +19064,20 @@ class UpdateIntegrationEmployeesRequest(AbstractModel):
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _InvitationNotifyType: 员工邀请方式
+如果是来自H5的，参数需要传递H5
+短信或者企微 请传递SMS，或者不传递
+        :type InvitationNotifyType: str
+        :param _JumpUrl: 回跳地址，
+在认证成功之后，进行回跳，请保证回跳地址的可用性。
+使用前请联系对接的客户经理沟通，提供回跳地址的域名，进行域名配置。
+        :type JumpUrl: str
         """
         self._Operator = None
         self._Employees = None
         self._Agent = None
+        self._InvitationNotifyType = None
+        self._JumpUrl = None
 
     @property
     def Operator(self):
@@ -18835,6 +19103,22 @@ class UpdateIntegrationEmployeesRequest(AbstractModel):
     def Agent(self, Agent):
         self._Agent = Agent
 
+    @property
+    def InvitationNotifyType(self):
+        return self._InvitationNotifyType
+
+    @InvitationNotifyType.setter
+    def InvitationNotifyType(self, InvitationNotifyType):
+        self._InvitationNotifyType = InvitationNotifyType
+
+    @property
+    def JumpUrl(self):
+        return self._JumpUrl
+
+    @JumpUrl.setter
+    def JumpUrl(self, JumpUrl):
+        self._JumpUrl = JumpUrl
+
 
     def _deserialize(self, params):
         if params.get("Operator") is not None:
@@ -18849,6 +19133,8 @@ class UpdateIntegrationEmployeesRequest(AbstractModel):
         if params.get("Agent") is not None:
             self._Agent = Agent()
             self._Agent._deserialize(params.get("Agent"))
+        self._InvitationNotifyType = params.get("InvitationNotifyType")
+        self._JumpUrl = params.get("JumpUrl")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]

{tencentcloud-sdk-python-ess-3.0.1063 → tencentcloud-sdk-python-ess-3.0.1076}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.0.1063
+Version: 3.0.1076
 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.1076/tencentcloud_sdk_python_ess.egg-info/requires.txt

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

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

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