tencentcloud-sdk-python-ess 3.1.122__tar.gz → 3.1.123__tar.gz

{tencentcloud_sdk_python_ess-3.1.122 → tencentcloud_sdk_python_ess-3.1.123}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.1.122
+Version: 3.1.123
 Summary: Tencent Cloud Ess SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.122
+Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.123
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_ess-3.1.122 → tencentcloud_sdk_python_ess-3.1.123}/setup.py

@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
 
 setup(
     name='tencentcloud-sdk-python-ess',
-    install_requires=["tencentcloud-sdk-python-common>=3.1.122,<4.0.0"],
+    install_requires=["tencentcloud-sdk-python-common>=3.1.123,<4.0.0"],
     
     version=tencentcloud.__version__,
     description='Tencent Cloud Ess SDK for Python',

{tencentcloud_sdk_python_ess-3.1.122 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.1.122'
+__version__ = '3.1.123'

{tencentcloud_sdk_python_ess-3.1.122 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/ess_client.py

@@ -153,6 +153,43 @@ class EssClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def CancelOrganizationFlows(self, request):
+        r"""全量撤销企业所有签署中的合同，单次任务最多支持撤销3000份合同。
+
+        适用场景：在企业信息变更场景下，签署中的合同需要全部撤销，全部重新发起，则可通过该接口取消签署中的合同流程，<font color='red'>需注意：该接口会将企业下签署中的合同都进行撤销操作，谨慎使用此接口。</font>
+
+        - **可撤回合同状态**：未全部签署完成
+        - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
+        批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
+
+
+        注:
+        - 有对应合同撤销权限的人:  <font color='red'>**发起人所在企业的超管、法人**</font>
+        - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
+        - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
+        - 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
+
+        :param request: Request instance for CancelOrganizationFlows.
+        :type request: :class:`tencentcloud.ess.v20201111.models.CancelOrganizationFlowsRequest`
+        :rtype: :class:`tencentcloud.ess.v20201111.models.CancelOrganizationFlowsResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("CancelOrganizationFlows", params, headers=headers)
+            response = json.loads(body)
+            model = models.CancelOrganizationFlowsResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def CancelUserAutoSignEnableUrl(self, request):
         r"""用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接，撤销生成的链接失效。
 

{tencentcloud_sdk_python_ess-3.1.122 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/ess_client_async.py

@@ -132,6 +132,38 @@ class EssClient(AbstractClient):
         
         return await self.call_and_deserialize(**kwargs)
         
+    async def CancelOrganizationFlows(
+            self,
+            request: models.CancelOrganizationFlowsRequest,
+            opts: Dict = None,
+    ) -> models.CancelOrganizationFlowsResponse:
+        """
+        全量撤销企业所有签署中的合同，单次任务最多支持撤销3000份合同。
+
+        适用场景：在企业信息变更场景下，签署中的合同需要全部撤销，全部重新发起，则可通过该接口取消签署中的合同流程，<font color='red'>需注意：该接口会将企业下签署中的合同都进行撤销操作，谨慎使用此接口。</font>
+
+        - **可撤回合同状态**：未全部签署完成
+        - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
+        批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
+
+
+        注:
+        - 有对应合同撤销权限的人:  <font color='red'>**发起人所在企业的超管、法人**</font>
+        - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
+        - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
+        - 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
+        """
+        
+        kwargs = {}
+        kwargs["action"] = "CancelOrganizationFlows"
+        kwargs["params"] = request._serialize()
+        kwargs["resp_cls"] = models.CancelOrganizationFlowsResponse
+        kwargs["headers"] = request.headers
+        kwargs["opts"] = opts or {}
+        
+        return await self.call_and_deserialize(**kwargs)
+        
     async def CancelUserAutoSignEnableUrl(
             self,
             request: models.CancelUserAutoSignEnableUrlRequest,

{tencentcloud_sdk_python_ess-3.1.122 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/models.py

@@ -3006,6 +3006,134 @@ class CancelMultiFlowSignQRCodeResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class CancelOrganizationFlowsRequest(AbstractModel):
+    r"""CancelOrganizationFlows请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Operator: <p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识:  Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证</p>
+        :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
+        :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _CancelMessage: <p>撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。 备注:<code>如果不传递撤回原因，那么默认撤回原因是 &quot;自动撤销（通过接口实现）&quot;</code></p>
+        :type CancelMessage: str
+        :param _CancelMessageFormat: <p>撤销理由自定义格式,  会展示在合同预览的界面中,  可以选择下面的组合方式：<strong>0</strong> : 默认格式,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同<strong>1</strong> :  合同封面页面会展示为:  发起方以<strong>CancelMessage</strong>的理由撤销当前合同<strong>2</strong> : 保留企业名称,  合同封面页面会展示为:  发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同<strong>3</strong> : 保留企业名称+经办人名字,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: <code>CancelMessage为撤销当前合同的理由</code><img src="https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png" alt="image"></p><p>枚举值：</p><ul><li>0： 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同</li><li>1： 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同</li><li>2： 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同</li><li>3： 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: CancelMessage为撤销当前合同的理由</li></ul>
+        :type CancelMessageFormat: int
+        """
+        self._Operator = None
+        self._Agent = None
+        self._CancelMessage = None
+        self._CancelMessageFormat = None
+
+    @property
+    def Operator(self):
+        r"""<p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识:  Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证</p>
+        :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        """
+        return self._Operator
+
+    @Operator.setter
+    def Operator(self, Operator):
+        self._Operator = Operator
+
+    @property
+    def Agent(self):
+        r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
+        :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
+        """
+        return self._Agent
+
+    @Agent.setter
+    def Agent(self, Agent):
+        self._Agent = Agent
+
+    @property
+    def CancelMessage(self):
+        r"""<p>撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。 备注:<code>如果不传递撤回原因，那么默认撤回原因是 &quot;自动撤销（通过接口实现）&quot;</code></p>
+        :rtype: str
+        """
+        return self._CancelMessage
+
+    @CancelMessage.setter
+    def CancelMessage(self, CancelMessage):
+        self._CancelMessage = CancelMessage
+
+    @property
+    def CancelMessageFormat(self):
+        r"""<p>撤销理由自定义格式,  会展示在合同预览的界面中,  可以选择下面的组合方式：<strong>0</strong> : 默认格式,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同<strong>1</strong> :  合同封面页面会展示为:  发起方以<strong>CancelMessage</strong>的理由撤销当前合同<strong>2</strong> : 保留企业名称,  合同封面页面会展示为:  发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同<strong>3</strong> : 保留企业名称+经办人名字,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: <code>CancelMessage为撤销当前合同的理由</code><img src="https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png" alt="image"></p><p>枚举值：</p><ul><li>0： 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同</li><li>1： 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同</li><li>2： 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同</li><li>3： 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: CancelMessage为撤销当前合同的理由</li></ul>
+        :rtype: int
+        """
+        return self._CancelMessageFormat
+
+    @CancelMessageFormat.setter
+    def CancelMessageFormat(self, CancelMessageFormat):
+        self._CancelMessageFormat = CancelMessageFormat
+
+
+    def _deserialize(self, params):
+        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"))
+        self._CancelMessage = params.get("CancelMessage")
+        self._CancelMessageFormat = params.get("CancelMessageFormat")
+        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 CancelOrganizationFlowsResponse(AbstractModel):
+    r"""CancelOrganizationFlows返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _TaskId: <p>批量撤销任务编号，为32位字符串，可用于<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">批量撤销任务结果回调</a></p>
+        :type TaskId: str
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._TaskId = None
+        self._RequestId = None
+
+    @property
+    def TaskId(self):
+        r"""<p>批量撤销任务编号，为32位字符串，可用于<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">批量撤销任务结果回调</a></p>
+        :rtype: str
+        """
+        return self._TaskId
+
+    @TaskId.setter
+    def TaskId(self, TaskId):
+        self._TaskId = TaskId
+
+    @property
+    def RequestId(self):
+        r"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :rtype: str
+        """
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._TaskId = params.get("TaskId")
+        self._RequestId = params.get("RequestId")
+
+
 class CancelUserAutoSignEnableUrlRequest(AbstractModel):
     r"""CancelUserAutoSignEnableUrl请求参数结构体
 

{tencentcloud_sdk_python_ess-3.1.122 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.1.122
+Version: 3.1.123
 Summary: Tencent Cloud Ess SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.122
+Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.123
 
 ============================
 Tencent Cloud SDK for Python

tencentcloud_sdk_python_ess-3.1.123/tencentcloud_sdk_python_ess.egg-info/requires.txt

@@ -0,0 +1 @@
+tencentcloud-sdk-python-common<4.0.0,>=3.1.123

tencentcloud_sdk_python_ess-3.1.122/tencentcloud_sdk_python_ess.egg-info/requires.txt

@@ -1 +0,0 @@
-tencentcloud-sdk-python-common<4.0.0,>=3.1.122