tencentcloud-sdk-python-ess 3.0.1069__tar.gz → 3.0.1079__tar.gz

{tencentcloud-sdk-python-ess-3.0.1069 → tencentcloud-sdk-python-ess-3.0.1079}/PKG-INFO

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

{tencentcloud-sdk-python-ess-3.0.1069 → tencentcloud-sdk-python-ess-3.0.1079}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1069'
+__version__ = '3.0.1079'

{tencentcloud-sdk-python-ess-3.0.1069 → tencentcloud-sdk-python-ess-3.0.1079}/tencentcloud/ess/v20201111/ess_client.py

@@ -363,6 +363,9 @@ class EssClient(AbstractClient):
         ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
 
         注：**静默（自动）签署不支持合同签署方存在填写**功能
+        <br>
+        **相关视频指引**
+        <a href="https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4" target="_blank">创建静默（自动）签署模板和开通自动签署</a>
 
         :param request: Request instance for CreateFlow.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowRequest`
@@ -452,7 +455,6 @@ class EssClient(AbstractClient):
         ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
 
         注：
-        - 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明
         -  合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
         - **静默（自动）签署不支持合同签署方存在填写**功能
 
@@ -678,15 +680,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 +733,36 @@ class EssClient(AbstractClient):
 
 
     def CreateIntegrationEmployees(self, request):
-        """此接口（CreateIntegrationEmployees）用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建，则不会重新创建，但会发送短信提醒员工实名。另外，此接口还支持通过企微组织架构的openid 创建员工（将WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内），该场景下，员工会接收到提醒实名的企微消息。
+        """此接口（CreateIntegrationEmployees）用于创建企业员工。
+        支持以下场景
+        <table>
+        <tbody>
+        <tr>
+        <td>生成端</td>
+        <td >入参</td>
+        <td>提醒方式</td>
+        </tr>
+        <tr>
+        <td>普通saas员工</td>
+        <td>不需要传递 InvitationNotifyType</td>
+        <td>短信</td>
+        </tr>
+        <tr>
+        <td>企微员工</td>
+        <td>不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内</td>
+        <td>企微内部实名消息</td>
+        </tr>
+        <tr>
+        <td>H5端 saas员工</td>
+        <td>传递 InvitationNotifyType = H5，不支持企微</td>
+        <td>生成H5链接</td>
+        </tr>
+        </tbody>
+        </table>
+        注意：
+
+        - <b>若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。</b>
+        - jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
 
         :param request: Request instance for CreateIntegrationEmployees.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateIntegrationEmployeesRequest`
@@ -853,6 +883,7 @@ class EssClient(AbstractClient):
         附注：
         - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。
         - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
+        - 仅支持待签署状态的合同生成签署链接。
 
         :param request: Request instance for CreateOrganizationBatchSignUrl.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateOrganizationBatchSignUrlRequest`
@@ -1981,8 +2012,11 @@ class EssClient(AbstractClient):
         ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
 
         注：
-        - **合同发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
-        - **静默（自动）签署不支持合同签署方存在填写**功能
+        1.<font color="red">合同发起后就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
+
+        2.<font color="red">静默（自动）签署不支持合同签署方存在填写</font>功能
+
+        3.<font color="red">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
 
         :param request: Request instance for StartFlow.
         :type request: :class:`tencentcloud.ess.v20201111.models.StartFlowRequest`
@@ -2030,8 +2064,35 @@ class EssClient(AbstractClient):
 
 
     def UpdateIntegrationEmployees(self, request):
-        """更新员工信息(姓名，手机号，邮件、部门)，用户实名后无法更改姓名与手机号。
-        可进行批量操作，Employees中的userID与openID二选一必填
+        """此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。
+        修改手机号的时候,支持以下场景进行提醒通知
+        <table>
+        <tbody>
+        <tr>
+        <td>生成端</td>
+        <td>入参</td>
+        <td>提醒方式</td>
+        </tr>
+        <tr>
+        <td>普通saas员工</td>
+        <td>不需要传递 InvitationNotifyType</td>
+        <td>短信</td>
+        </tr>
+        <tr>
+        <td>企微员工</td>
+        <td>不需要传递 InvitationNotifyType，将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，但需确保该企微员工在应用的可见范围内</td>
+        <td>企微内部实名消息</td>
+        </tr>
+        <tr>
+        <td>H5端 saas员工</td>
+        <td>传递 InvitationNotifyType = H5，不支持企微</td>
+        <td>生成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.1069 → tencentcloud-sdk-python-ess-3.0.1079}/tencentcloud/ess/v20201111/models.py

@@ -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（点）。
@@ -1955,6 +1962,8 @@ class Component(AbstractModel):
 
 注：`控件ID可以在一个PDF中不可重复`
 
+<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentId在模板编辑页面的位置</a>
+
         :type ComponentId: str
         :param _ComponentName: **在绝对定位方式方式下**，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。
 
@@ -1962,6 +1971,7 @@ class Component(AbstractModel):
 
 注：`控件名可以在一个PDF中可以重复`
 
+<a href="https://qcloudimg.tencent-cloud.cn/raw/93178569d07b4d7dbbe0967ae679e35c.png" target="_blank">点击查看ComponentName在模板页面的位置</a>
         :type ComponentName: str
         :param _ComponentRequired: 如果是<b>填写控件</b>，ComponentRequired表示在填写页面此控件是否必填
 <ul><li>false（默认）：可以不填写</li>
@@ -2006,6 +2016,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，表示取不到有效值。
@@ -3899,6 +3915,9 @@ class CreateFlowByFilesRequest(AbstractModel):
 签署方：李四
 
 
+![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
+
+
         :type CustomShowMap: str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -5108,7 +5127,7 @@ class CreateFlowRequest(AbstractModel):
 <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
 注：`请和模板中的配置保持一致`
         :type Unordered: bool
-        :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
+        :param _CustomShowMap: 您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量：
 <ul><li>{合同名称}   </li>
 <li>{发起方企业} </li>
 <li>{发起方姓名} </li>
@@ -5122,6 +5141,8 @@ class CreateFlowRequest(AbstractModel):
 发起方：腾讯公司(张三) 
 签署方：李四
 
+![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
+
 
         :type CustomShowMap: str
         :param _NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
@@ -5556,29 +5577,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 +5617,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 +5633,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 +5661,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 +5907,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 +5947,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 +5977,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:]
@@ -6978,12 +7045,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 +7078,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 +7118,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 +7159,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 +7215,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 +7294,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 +7306,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"))
@@ -11438,7 +11506,7 @@ class DescribeIntegrationRolesRequest(AbstractModel):
 分页参数, 需要limit, offset 配合使用
 例如:
 您希望得到第三页的数据, 且每页限制最多10条
-你可以使用 LIMIT 10 OFFSET 20
+您可以使用 LIMIT 10 OFFSET 20
 
         :type Offset: int
         """
@@ -11525,7 +11593,7 @@ class DescribeIntegrationRolesResponse(AbstractModel):
 分页参数, 需要limit, offset 配合使用
 例如:
 您希望得到第三页的数据, 且每页限制最多10条
-你可以使用 LIMIT 10 OFFSET 20
+您可以使用 LIMIT 10 OFFSET 20
         :type Offset: int
         :param _Limit: 指定分页每页返回的数据条数，单页最大支持 200。
         :type Limit: int
@@ -18285,7 +18353,8 @@ class StartFlowResponse(AbstractModel):
 
 
 class SuccessCreateStaffData(AbstractModel):
-    """创建员工的成功数据
+    """创建员工成功返回的信息
+    支持saas/企微/H5端进行加入。
 
     """
 
@@ -18302,12 +18371,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):
@@ -18349,6 +18423,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")
@@ -18356,6 +18438,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:]
@@ -18424,7 +18507,9 @@ class SuccessDeleteStaffData(AbstractModel):
 
 
 class SuccessUpdateStaffData(AbstractModel):
-    """更新员工信息成功返回的数据信息
+    """更新员工信息成功返回的数据信息， 仅支持未实名的用户进行更新
+    会通过短信、企微消息或者H5Url 链接
+    如果是通过H5邀请加入的方式，会返回H5 链接
 
     """
 
@@ -18437,10 +18522,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):
@@ -18466,11 +18556,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:]
@@ -18973,10 +19072,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):
@@ -19002,6 +19111,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:
@@ -19016,6 +19141,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.1069 → tencentcloud-sdk-python-ess-3.0.1079}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO

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

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

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

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