tencentcloud-sdk-python-ess 3.1.110__tar.gz → 3.1.111__tar.gz

{tencentcloud_sdk_python_ess-3.1.110 → tencentcloud_sdk_python_ess-3.1.111}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.1.110
+Version: 3.1.111
 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.110
+Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.111
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_ess-3.1.110 → tencentcloud_sdk_python_ess-3.1.111}/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.110,<4.0.0"],
+    install_requires=["tencentcloud-sdk-python-common>=3.1.111,<4.0.0"],
     
     version=tencentcloud.__version__,
     description='Tencent Cloud Ess SDK for Python',

{tencentcloud_sdk_python_ess-3.1.110 → tencentcloud_sdk_python_ess-3.1.111}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.1.110'
+__version__ = '3.1.111'

{tencentcloud_sdk_python_ess-3.1.110 → tencentcloud_sdk_python_ess-3.1.111}/tencentcloud/ess/v20201111/ess_client.py

@@ -1386,16 +1386,33 @@ class EssClient(AbstractClient):
 
 
     def CreateFlowReminds(self, request):
-        r"""指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+        r"""指定需要批量催办的签署流程ID，批量催办合同，最多100个
+        ##### 需要符合以下条件的合同才可被催办：
+        <ol>
+        <li>发起合同时，**设置了签署人通知类型：SMS,EMAIL,ALL**</li>
+        <li>合同中当前状态为 **待签署** 的签署人是催办的对象</li>
+        <li>**每个合同的每个签署方最多3次*</li>
+        </ol>
 
-        1. 发起合同时，**签署人的NotifyType需设置为sms**
-        2. 合同中当前状态为 **待签署** 的签署人是催办的对象
-        3. **每个合同的每个签署方只能催办一次**
+        ##### 催办的规则和效果：
+        ###### 规则
 
-        **催办的效果**: 对方会收到如下的短信通知
+        - 指定RemindTypes，会触发符合签署人NotifyType的通知类型
+            -  这里EMAIL类型例外，如果指定了RemindEmailInfos，那么就会按照指定的email来通知，不管签署人NotifyType是否设置了EMAIL通知类型
+                - 如果指定了RemindEmailInfos，那么就会按照指定的email来通知
+        - 若未指定RemindTypes，则按照发起合同时设置的签署人原始通知类型处理
+
+        ###### 效果
+
+
+        <li>对方会收到如下的短信通知</li>
 
         ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
 
+        <li>对方会收到如下的邮件通知</li>
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/0841ccbd8db9747760b17914dcc166c6.png)
+
         注：`合同催办是白名单功能，请联系客户经理申请开白后使用`
 
         :param request: Request instance for CreateFlowReminds.

{tencentcloud_sdk_python_ess-3.1.110 → tencentcloud_sdk_python_ess-3.1.111}/tencentcloud/ess/v20201111/ess_client_async.py

@@ -1195,16 +1195,33 @@ class EssClient(AbstractClient):
             opts: Dict = None,
     ) -> models.CreateFlowRemindsResponse:
         """
-        指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+        指定需要批量催办的签署流程ID，批量催办合同，最多100个
+        ##### 需要符合以下条件的合同才可被催办：
+        <ol>
+        <li>发起合同时，**设置了签署人通知类型：SMS,EMAIL,ALL**</li>
+        <li>合同中当前状态为 **待签署** 的签署人是催办的对象</li>
+        <li>**每个合同的每个签署方最多3次*</li>
+        </ol>
 
-        1. 发起合同时，**签署人的NotifyType需设置为sms**
-        2. 合同中当前状态为 **待签署** 的签署人是催办的对象
-        3. **每个合同的每个签署方只能催办一次**
+        ##### 催办的规则和效果：
+        ###### 规则
 
-        **催办的效果**: 对方会收到如下的短信通知
+        - 指定RemindTypes，会触发符合签署人NotifyType的通知类型
+            -  这里EMAIL类型例外，如果指定了RemindEmailInfos，那么就会按照指定的email来通知，不管签署人NotifyType是否设置了EMAIL通知类型
+                - 如果指定了RemindEmailInfos，那么就会按照指定的email来通知
+        - 若未指定RemindTypes，则按照发起合同时设置的签署人原始通知类型处理
+
+        ###### 效果
+
+
+        <li>对方会收到如下的短信通知</li>
 
         ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
 
+        <li>对方会收到如下的邮件通知</li>
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/0841ccbd8db9747760b17914dcc166c6.png)
+
         注：`合同催办是白名单功能，请联系客户经理申请开白后使用`
         """
         

{tencentcloud_sdk_python_ess-3.1.110 → tencentcloud_sdk_python_ess-3.1.111}/tencentcloud/ess/v20201111/models.py

@@ -16696,38 +16696,25 @@ class CreateOrganizationBatchSignUrlRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Operator: 执行本接口操作的员工信息。使用此接口时，必须填写userId。
-支持填入集团子公司经办人 userId 代发合同。
-
-注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :param _Operator: <p>执行本接口操作的员工信息。使用此接口时，必须填写userId。<br>支持填入集团子公司经办人 userId 代发合同。</p><p>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
-        :param _FlowIds: 请指定需执行批量签署的流程ID，数量范围为1-100。您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。用户将利用链接对这些合同实施批量操作。  注：生成动态签署方领取时此参数必传。 
+        :param _FlowIds: <p>请指定需执行批量签署的流程ID，数量范围为1-100。您可登录腾讯电子签控制台，浏览 &quot;合同&quot;-&gt;&quot;合同中心&quot; 以查阅某一合同的FlowId（在页面中显示为合同ID）。用户将利用链接对这些合同实施批量操作。  注：生成动态签署方领取时此参数必传。</p>
         :type FlowIds: list of str
-        :param _Agent: 代理企业和员工的信息。
-在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
-        :param _UserId: 员工在腾讯电子签平台的独特身份标识，为32位字符串。
-您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。
-UserId必须是传入合同（FlowId）中的签署人。
-
-<ul>
-<li>1. 若UserId为空，Name和Mobile 必须提供。</li>
-<li>2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。</li>
-</ul>
+        :param _UserId: <p>员工在腾讯电子签平台的独特身份标识，为32位字符串。<br>您可登录腾讯电子签控制台，在 &quot;更多能力&quot;-&gt;&quot;组织管理&quot; 中查阅某位员工的UserId（在页面中显示为用户ID）。<br>UserId必须是传入合同（FlowId）中的签署人。</p><ul><li>1. 若UserId为空，Name和Mobile 必须提供。</li><li>2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。</li></ul>
         :type UserId: str
-        :param _Name: 员工姓名，必须与手机号码一起使用。
-如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
+        :param _Name: <p>员工姓名，必须与手机号码一起使用。<br>如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。</p>
         :type Name: str
-        :param _Mobile: 员工手机号，必须与姓名一起使用。
- 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
+        :param _Mobile: <p>员工手机号，必须与姓名一起使用。<br> 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。</p>
         :type Mobile: str
-        :param _RecipientIds: 为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。您可以通过查询合同接口（DescribeFlowInfo）查询此参数。若传了此参数，则可以不传 UserId, Name, Mobile等参数  注：生成动态签署方领取时此参数必传。
+        :param _RecipientIds: <p>为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。您可以通过查询合同接口（DescribeFlowInfo）查询此参数。若传了此参数，则可以不传 UserId, Name, Mobile等参数  注：生成动态签署方领取时此参数必传。</p>
         :type RecipientIds: list of str
-        :param _FlowGroupId: 合同组Id，传入此参数则可以不传FlowIds
+        :param _FlowGroupId: <p>合同组Id，传入此参数则可以不传FlowIds</p>
         :type FlowGroupId: str
-        :param _CanBatchReject: 是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注：`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。`
+        :param _CanBatchReject: <p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p>
         :type CanBatchReject: bool
-        :param _DynamicSignOption: 动态签署方领取链接配置。
+        :param _DynamicSignOption: <p>动态签署方领取链接配置。</p>
         :type DynamicSignOption: :class:`tencentcloud.ess.v20201111.models.DynamicSignOption`
         """
         self._Operator = None
@@ -16743,10 +16730,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def Operator(self):
-        r"""执行本接口操作的员工信息。使用此接口时，必须填写userId。
-支持填入集团子公司经办人 userId 代发合同。
-
-注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        r"""<p>执行本接口操作的员工信息。使用此接口时，必须填写userId。<br>支持填入集团子公司经办人 userId 代发合同。</p><p>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
         :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
         """
         return self._Operator
@@ -16757,7 +16741,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def FlowIds(self):
-        r"""请指定需执行批量签署的流程ID，数量范围为1-100。您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。用户将利用链接对这些合同实施批量操作。  注：生成动态签署方领取时此参数必传。 
+        r"""<p>请指定需执行批量签署的流程ID，数量范围为1-100。您可登录腾讯电子签控制台，浏览 &quot;合同&quot;-&gt;&quot;合同中心&quot; 以查阅某一合同的FlowId（在页面中显示为合同ID）。用户将利用链接对这些合同实施批量操作。  注：生成动态签署方领取时此参数必传。</p>
         :rtype: list of str
         """
         return self._FlowIds
@@ -16768,8 +16752,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def Agent(self):
-        r"""代理企业和员工的信息。
-在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
         :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
         """
         return self._Agent
@@ -16780,14 +16763,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def UserId(self):
-        r"""员工在腾讯电子签平台的独特身份标识，为32位字符串。
-您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。
-UserId必须是传入合同（FlowId）中的签署人。
-
-<ul>
-<li>1. 若UserId为空，Name和Mobile 必须提供。</li>
-<li>2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。</li>
-</ul>
+        r"""<p>员工在腾讯电子签平台的独特身份标识，为32位字符串。<br>您可登录腾讯电子签控制台，在 &quot;更多能力&quot;-&gt;&quot;组织管理&quot; 中查阅某位员工的UserId（在页面中显示为用户ID）。<br>UserId必须是传入合同（FlowId）中的签署人。</p><ul><li>1. 若UserId为空，Name和Mobile 必须提供。</li><li>2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。</li></ul>
         :rtype: str
         """
         return self._UserId
@@ -16798,8 +16774,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def Name(self):
-        r"""员工姓名，必须与手机号码一起使用。
-如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
+        r"""<p>员工姓名，必须与手机号码一起使用。<br>如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。</p>
         :rtype: str
         """
         return self._Name
@@ -16810,8 +16785,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def Mobile(self):
-        r"""员工手机号，必须与姓名一起使用。
- 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
+        r"""<p>员工手机号，必须与姓名一起使用。<br> 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。</p>
         :rtype: str
         """
         return self._Mobile
@@ -16822,7 +16796,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def RecipientIds(self):
-        r"""为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。您可以通过查询合同接口（DescribeFlowInfo）查询此参数。若传了此参数，则可以不传 UserId, Name, Mobile等参数  注：生成动态签署方领取时此参数必传。
+        r"""<p>为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。您可以通过查询合同接口（DescribeFlowInfo）查询此参数。若传了此参数，则可以不传 UserId, Name, Mobile等参数  注：生成动态签署方领取时此参数必传。</p>
         :rtype: list of str
         """
         return self._RecipientIds
@@ -16833,7 +16807,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def FlowGroupId(self):
-        r"""合同组Id，传入此参数则可以不传FlowIds
+        r"""<p>合同组Id，传入此参数则可以不传FlowIds</p>
         :rtype: str
         """
         return self._FlowGroupId
@@ -16844,7 +16818,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def CanBatchReject(self):
-        r"""是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注：`当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。`
+        r"""<p>是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul></p>
         :rtype: bool
         """
         return self._CanBatchReject
@@ -16855,7 +16829,7 @@ UserId必须是传入合同（FlowId）中的签署人。
 
     @property
     def DynamicSignOption(self):
-        r"""动态签署方领取链接配置。
+        r"""<p>动态签署方领取链接配置。</p>
         :rtype: :class:`tencentcloud.ess.v20201111.models.DynamicSignOption`
         """
         return self._DynamicSignOption
@@ -16899,9 +16873,9 @@ class CreateOrganizationBatchSignUrlResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _SignUrl: 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
+        :param _SignUrl: <p>批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。</p>
         :type SignUrl: str
-        :param _ExpiredTime: 链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
+        :param _ExpiredTime: <p>链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。</p>
         :type ExpiredTime: int
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
@@ -16912,7 +16886,7 @@ class CreateOrganizationBatchSignUrlResponse(AbstractModel):
 
     @property
     def SignUrl(self):
-        r"""批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
+        r"""<p>批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。</p>
         :rtype: str
         """
         return self._SignUrl
@@ -16923,7 +16897,7 @@ class CreateOrganizationBatchSignUrlResponse(AbstractModel):
 
     @property
     def ExpiredTime(self):
-        r"""链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
+        r"""<p>链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。</p>
         :rtype: int
         """
         return self._ExpiredTime

{tencentcloud_sdk_python_ess-3.1.110 → tencentcloud_sdk_python_ess-3.1.111}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-ess
-Version: 3.1.110
+Version: 3.1.111
 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.110
+Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.111
 
 ============================
 Tencent Cloud SDK for Python

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

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

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

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