tencentcloud-sdk-python-ess 3.0.1075__tar.gz → 3.0.1085__tar.gz

{tencentcloud-sdk-python-ess-3.0.1075 → tencentcloud-sdk-python-ess-3.0.1085}/PKG-INFO

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

{tencentcloud-sdk-python-ess-3.0.1075 → tencentcloud-sdk-python-ess-3.0.1085}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1075'
+__version__ = '3.0.1085'

{tencentcloud-sdk-python-ess-3.0.1075 → tencentcloud-sdk-python-ess-3.0.1085}/tencentcloud/ess/v20201111/ess_client.py

@@ -363,6 +363,11 @@ class EssClient(AbstractClient):
         ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
 
         注：**静默（自动）签署不支持合同签署方存在填写**功能
+        <br>
+
+        <font color="red">相关视频指引</font> <br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4" target="_blank">创建静默（自动）签署模板和开通自动签署</a><br>
+        2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模版创建发起合同</a><br>
 
         :param request: Request instance for CreateFlow.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowRequest`
@@ -452,7 +457,6 @@ class EssClient(AbstractClient):
         ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
 
         注：
-        - 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明
         -  合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
         - **静默（自动）签署不支持合同签署方存在填写**功能
 
@@ -678,15 +682,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 +735,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 +885,7 @@ class EssClient(AbstractClient):
         附注：
         - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。
         - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
+        - 仅支持待签署状态的合同生成签署链接。
 
         :param request: Request instance for CreateOrganizationBatchSignUrl.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateOrganizationBatchSignUrlRequest`
@@ -1918,6 +1951,39 @@ class EssClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def ModifyFlowDeadline(self, request):
+        """在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：
+        1. 合同（流程）维度：只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
+        2. 签署人维度：需要传递流程ID和签署人ID。此操作将对签署人进行延期操作，尤其对于有序的合同（流程），签署截止时间不能超过后一位合同（流程）签署人的流程截止时间。
+
+        此接口有如下限制条件：
+        1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
+        2. 在延长整个签署流程时，签署流程应至少还有一方未签署（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态）。
+        3. 在延长整个签署流程时，新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
+        4. 在延长签署方的截止时间时，签署方不能处于流程完结或已终止状态（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
+        5. 在延长签署方的截止时间时，签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同，还应早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
+        6. 不支持操作合同组合同。
+
+        :param request: Request instance for ModifyFlowDeadline.
+        :type request: :class:`tencentcloud.ess.v20201111.models.ModifyFlowDeadlineRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.ModifyFlowDeadlineResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("ModifyFlowDeadline", params, headers=headers)
+            response = json.loads(body)
+            model = models.ModifyFlowDeadlineResponse()
+            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和部门序号等信息。
 
@@ -1981,8 +2047,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 +2099,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.1075 → tencentcloud-sdk-python-ess-3.0.1085}/tencentcloud/ess/v20201111/models.py

@@ -319,6 +319,10 @@ class ApproverInfo(AbstractModel):
         :type AddSignComponentsLimits: list of ComponentLimit
         :param _SignInstructionContent: 签署须知：支持传入富文本，最长字数：500个中文字符
         :type SignInstructionContent: str
+        :param _Deadline: 签署人的签署截止时间，格式为Unix标准时间戳（秒）
+
+注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
+        :type Deadline: int
         """
         self._ApproverType = None
         self._ApproverName = None
@@ -341,6 +345,7 @@ class ApproverInfo(AbstractModel):
         self._ApproverNeedSignReview = None
         self._AddSignComponentsLimits = None
         self._SignInstructionContent = None
+        self._Deadline = None
 
     @property
     def ApproverType(self):
@@ -510,6 +515,14 @@ class ApproverInfo(AbstractModel):
     def SignInstructionContent(self, SignInstructionContent):
         self._SignInstructionContent = SignInstructionContent
 
+    @property
+    def Deadline(self):
+        return self._Deadline
+
+    @Deadline.setter
+    def Deadline(self, Deadline):
+        self._Deadline = Deadline
+
 
     def _deserialize(self, params):
         self._ApproverType = params.get("ApproverType")
@@ -545,6 +558,7 @@ class ApproverInfo(AbstractModel):
                 obj._deserialize(item)
                 self._AddSignComponentsLimits.append(obj)
         self._SignInstructionContent = params.get("SignInstructionContent")
+        self._Deadline = params.get("Deadline")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -1905,8 +1919,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 +1929,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 +1976,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 +1985,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>
@@ -3157,12 +3181,13 @@ class CreateDocumentRequest(AbstractModel):
         r"""
         :param _Operator: 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
+
+[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)
+        :type TemplateId: str
         :param _FlowId: 合同流程ID，为32位字符串。
 此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
         :type FlowId: str
-        :param _TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
-可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
-        :type TemplateId: str
         :param _FileNames: 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
         :type FileNames: list of str
         :param _FormFields: 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
@@ -3191,8 +3216,8 @@ class CreateDocumentRequest(AbstractModel):
         :type ClientToken: str
         """
         self._Operator = None
-        self._FlowId = None
         self._TemplateId = None
+        self._FlowId = None
         self._FileNames = None
         self._FormFields = None
         self._NeedPreview = None
@@ -3208,14 +3233,6 @@ class CreateDocumentRequest(AbstractModel):
     def Operator(self, Operator):
         self._Operator = Operator
 
-    @property
-    def FlowId(self):
-        return self._FlowId
-
-    @FlowId.setter
-    def FlowId(self, FlowId):
-        self._FlowId = FlowId
-
     @property
     def TemplateId(self):
         return self._TemplateId
@@ -3224,6 +3241,14 @@ class CreateDocumentRequest(AbstractModel):
     def TemplateId(self, TemplateId):
         self._TemplateId = TemplateId
 
+    @property
+    def FlowId(self):
+        return self._FlowId
+
+    @FlowId.setter
+    def FlowId(self, FlowId):
+        self._FlowId = FlowId
+
     @property
     def FileNames(self):
         return self._FileNames
@@ -3277,8 +3302,8 @@ class CreateDocumentRequest(AbstractModel):
         if params.get("Operator") is not None:
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
-        self._FlowId = params.get("FlowId")
         self._TemplateId = params.get("TemplateId")
+        self._FlowId = params.get("FlowId")
         self._FileNames = params.get("FileNames")
         if params.get("FormFields") is not None:
             self._FormFields = []
@@ -3905,6 +3930,9 @@ class CreateFlowByFilesRequest(AbstractModel):
 签署方：李四
 
 
+![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
+
+
         :type CustomShowMap: str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -4173,9 +4201,10 @@ class CreateFlowByFilesResponse(AbstractModel):
         r"""
         :param _FlowId: 合同流程ID，为32位字符串。
 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
-可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
 
 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
+
+[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         :type FlowId: str
         :param _PreviewUrl: 合同预览链接URL。
 
@@ -5114,7 +5143,7 @@ class CreateFlowRequest(AbstractModel):
 <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
 注：`请和模板中的配置保持一致`
         :type Unordered: bool
-        :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
+        :param _CustomShowMap: 您可以自定义**腾讯电子签小程序合同列表页**展示的合同内容模板，模板中支持以下变量：
 <ul><li>{合同名称}   </li>
 <li>{发起方企业} </li>
 <li>{发起方姓名} </li>
@@ -5128,6 +5157,8 @@ class CreateFlowRequest(AbstractModel):
 发起方：腾讯公司(张三) 
 签署方：李四
 
+![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
+
 
         :type CustomShowMap: str
         :param _NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
@@ -5368,7 +5399,7 @@ class CreateFlowResponse(AbstractModel):
 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
 
 注:
-此返回的合同流程ID，需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后，合同才能进入签署环节
+此返回的合同流程ID，需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后，合同才能进入签署环节，[点击产看FlowId在控制台中的位置（只在进如签署环节后有效）](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
 
 
         :type FlowId: str
@@ -5562,29 +5593,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):
@@ -5594,14 +5633,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
@@ -5618,6 +5649,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) 
@@ -5638,25 +5677,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:]
@@ -5875,10 +5923,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):
@@ -5904,6 +5963,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:
@@ -5918,6 +5993,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:]
@@ -10394,6 +10471,8 @@ class DescribeFlowBriefsRequest(AbstractModel):
 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
 
 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+
+[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         :type FlowIds: list of str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -10725,6 +10804,11 @@ class DescribeFlowInfoRequest(AbstractModel):
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
         :param _FlowIds: 需要查询的流程ID列表，最多可传入100个ID。
 如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
+
+
+可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+
+[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         :type FlowIds: list of str
         :param _Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。	
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
@@ -13955,6 +14039,11 @@ class FlowCreateApprover(AbstractModel):
 注：
 `不指定该值时，默认为签署方自行选择。`
         :type SignTypeSelector: int
+        :param _Deadline: Deadline
+签署人的签署截止时间，格式为Unix标准时间戳（秒）
+
+注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
+        :type Deadline: int
         """
         self._ApproverType = None
         self._OrganizationName = None
@@ -13982,6 +14071,7 @@ class FlowCreateApprover(AbstractModel):
         self._ApproverVerifyTypes = None
         self._ApproverSignTypes = None
         self._SignTypeSelector = None
+        self._Deadline = None
 
     @property
     def ApproverType(self):
@@ -14195,6 +14285,14 @@ class FlowCreateApprover(AbstractModel):
     def SignTypeSelector(self, SignTypeSelector):
         self._SignTypeSelector = SignTypeSelector
 
+    @property
+    def Deadline(self):
+        return self._Deadline
+
+    @Deadline.setter
+    def Deadline(self, Deadline):
+        self._Deadline = Deadline
+
 
     def _deserialize(self, params):
         self._ApproverType = params.get("ApproverType")
@@ -14237,6 +14335,7 @@ class FlowCreateApprover(AbstractModel):
         self._ApproverVerifyTypes = params.get("ApproverVerifyTypes")
         self._ApproverSignTypes = params.get("ApproverSignTypes")
         self._SignTypeSelector = params.get("SignTypeSelector")
+        self._Deadline = params.get("Deadline")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -15971,6 +16070,122 @@ class ModifyExtendedServiceResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class ModifyFlowDeadlineRequest(AbstractModel):
+    """ModifyFlowDeadline请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Operator: 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _FlowId: 合同流程ID，为32位字符串。
+<ul><li>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</li>
+<li>可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
+        :type FlowId: str
+        :param _Deadline: 签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）
+        :type Deadline: int
+        :param _Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _RecipientId: 签署方角色编号，为32位字符串
+<ul><li>若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间）</li>
+<li>通过[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)发起合同，或通过[模板发起合同-创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)时，返回参数[Approvers](https://qian.tencent.com/developers/companyApis/dataTypes/#approveritem)会返回此信息，建议开发者妥善保存</li>
+<li>也可通过[查询合同流程的详情信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo)接口查询签署人的RecipientId编号</li></ul>
+        :type RecipientId: str
+        """
+        self._Operator = None
+        self._FlowId = None
+        self._Deadline = None
+        self._Agent = None
+        self._RecipientId = None
+
+    @property
+    def Operator(self):
+        return self._Operator
+
+    @Operator.setter
+    def Operator(self, Operator):
+        self._Operator = Operator
+
+    @property
+    def FlowId(self):
+        return self._FlowId
+
+    @FlowId.setter
+    def FlowId(self, FlowId):
+        self._FlowId = FlowId
+
+    @property
+    def Deadline(self):
+        return self._Deadline
+
+    @Deadline.setter
+    def Deadline(self, Deadline):
+        self._Deadline = Deadline
+
+    @property
+    def Agent(self):
+        return self._Agent
+
+    @Agent.setter
+    def Agent(self, Agent):
+        self._Agent = Agent
+
+    @property
+    def RecipientId(self):
+        return self._RecipientId
+
+    @RecipientId.setter
+    def RecipientId(self, RecipientId):
+        self._RecipientId = RecipientId
+
+
+    def _deserialize(self, params):
+        if params.get("Operator") is not None:
+            self._Operator = UserInfo()
+            self._Operator._deserialize(params.get("Operator"))
+        self._FlowId = params.get("FlowId")
+        self._Deadline = params.get("Deadline")
+        if params.get("Agent") is not None:
+            self._Agent = Agent()
+            self._Agent._deserialize(params.get("Agent"))
+        self._RecipientId = params.get("RecipientId")
+        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 ModifyFlowDeadlineResponse(AbstractModel):
+    """ModifyFlowDeadline返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._RequestId = None
+
+    @property
+    def RequestId(self):
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._RequestId = params.get("RequestId")
+
+
 class ModifyIntegrationDepartmentRequest(AbstractModel):
     """ModifyIntegrationDepartment请求参数结构体
 
@@ -18292,7 +18507,8 @@ class StartFlowResponse(AbstractModel):
 
 
 class SuccessCreateStaffData(AbstractModel):
-    """创建员工的成功数据
+    """创建员工成功返回的信息
+    支持saas/企微/H5端进行加入。
 
     """
 
@@ -18309,12 +18525,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):
@@ -18356,6 +18577,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")
@@ -18363,6 +18592,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:]
@@ -18431,7 +18661,9 @@ class SuccessDeleteStaffData(AbstractModel):
 
 
 class SuccessUpdateStaffData(AbstractModel):
-    """更新员工信息成功返回的数据信息
+    """更新员工信息成功返回的数据信息， 仅支持未实名的用户进行更新
+    会通过短信、企微消息或者H5Url 链接
+    如果是通过H5邀请加入的方式，会返回H5 链接
 
     """
 
@@ -18444,10 +18676,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):
@@ -18473,11 +18710,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:]
@@ -18980,10 +19226,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):
@@ -19009,6 +19265,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:
@@ -19023,6 +19295,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.1075 → tencentcloud-sdk-python-ess-3.0.1085}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO

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

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

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

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