tencentcloud-sdk-python-essbasic 3.1.58__py2.py3-none-any.whl → 3.1.59__py2.py3-none-any.whl

tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.1.58'
+__version__ = '3.1.59'

tencentcloud/essbasic/v20210526/models.py

@@ -18086,111 +18086,46 @@ class CreateSignUrlsRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
-
-此接口下面信息必填。
-<ul>
-<li>渠道应用标识:  Agent.AppId</li>
-<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
-<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
-</ul>
-第三方平台子客企业和员工必须已经过实名认证
+        :param _Agent: <p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识:  Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
-        :param _FlowIds: 合同流程ID数组，最多支持100个。
-
-注: 
-1. 必须选择提供此参数或合同组编号中的一个。
-2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
+        :param _FlowIds: <p>合同流程ID数组，最多支持100个。</p><p>注: </p><ol><li>必须选择提供此参数或合同组编号中的一个。</li><li>当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。</li></ol>
         :type FlowIds: list of str
-        :param _FlowGroupId: 合同组编号
-注：`该参数和合同流程ID数组必须二选一`
+        :param _FlowGroupId: <p>合同组编号<br>注：<code>该参数和合同流程ID数组必须二选一</code></p>
         :type FlowGroupId: str
-        :param _Endpoint: 签署链接类型,可以设置的参数如下
-<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链</li>
-<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
-<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
-<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul>
-
-**注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。
-
-详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
-
+        :param _Endpoint: <p>签署链接类型,可以设置的参数如下</p><ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链</li><li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li><li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li><li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul><p><strong>注：</strong>动态签署人场景，如果签署链接类型设置为<code>APP</code>，则仅支持跳转到封面页。</p><p>详细使用场景可以参考接口描述说明中的 <strong>主要使用场景EndPoint分类</strong></p>
         :type Endpoint: str
-        :param _GenerateType: 签署链接生成类型，可以选择的类型如下
-
-<ul><li><strong>ALL</strong>：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：<strong>此中类型不支持多个合同ID（FlowIds）</strong>。</li>
-<li><strong>CHANNEL</strong>：适用于第三方子企业的员工签署方。</li>
-<li><strong>NOT_CHANNEL</strong>：适用于SaaS平台企业的员工签署方。</li>
-<li><strong>PERSON</strong>：适用于个人或自然人签署方。</li>
-<li><strong>FOLLOWER</strong>：适用于关注方，目前指合同的抄送方。</li>
-<li><strong>RECIPIENT</strong>：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。</li></ul>
+        :param _GenerateType: <p>签署链接生成类型，可以选择的类型如下</p><ul><li><strong>ALL</strong>：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：<strong>此中类型不支持多个合同ID（FlowIds）</strong>。</li><li><strong>CHANNEL</strong>：适用于第三方子企业的员工签署方。</li><li><strong>NOT_CHANNEL</strong>：适用于SaaS平台企业的员工签署方。</li><li><strong>PERSON</strong>：适用于个人或自然人签署方。</li><li><strong>FOLLOWER</strong>：适用于关注方，目前指合同的抄送方。</li><li><strong>RECIPIENT</strong>：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。</li></ul>
         :type GenerateType: str
-        :param _OrganizationName: SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。  注:  `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
+        :param _OrganizationName: <p>SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。  注:  <code>1.GenerateType为&quot;NOT_CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署</code></p>
         :type OrganizationName: str
-        :param _Name: 合同流程里边参与方的姓名。
-注: 
-1. `GenerateType为"PERSON"(即个人签署方)时必填`。
-2. `在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
+        :param _Name: <p>合同流程里边参与方的姓名。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;(即个人签署方)时必填</code>。</li><li><code>在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
         :type Name: str
-        :param _Mobile: 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
-注:  
-1. `GenerateType为"PERSON"或"FOLLOWER"时必填。`
-2. `在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
+        :param _Mobile: <p>合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>注:  </p><ol><li><code>GenerateType为&quot;PERSON&quot;或&quot;FOLLOWER&quot;时必填。</code></li><li><code>在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
         :type Mobile: str
-        :param _IdCardType: 证件类型，支持以下类型
-<ul><li>ID_CARD : 中国大陆居民身份证</li>
-<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
-<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
-
-`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
+        :param _IdCardType: <p>证件类型，支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p><code>注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。</code></p>
         :type IdCardType: str
-        :param _IdCardNumber: 证件号码，应符合以下规则
-<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
-<li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
-<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
-
-`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
+        :param _IdCardNumber: <p>证件号码，应符合以下规则</p><ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul><p><code>注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></p>
         :type IdCardNumber: str
-        :param _OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注:  `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
+        :param _OrganizationOpenId: <p>第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注:  <code>1.GenerateType为&quot;CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署</code></p>
         :type OrganizationOpenId: str
-        :param _OpenId: 第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息
-
-注： 
-如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）
+        :param _OpenId: <p>第三方平台子客企业员工的标识OpenId，GenerateType为&quot;CHANNEL&quot;时可用，指定到具体参与人, 仅展示已经实名的经办人信息</p><p>注：<br>如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）</p>
         :type OpenId: str
-        :param _AutoJumpBack: 签署完成后是否自动回跳
-<ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
-
-注: 
-1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
-2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
-3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font> 
+        :param _AutoJumpBack: <p>签署完成后是否自动回跳</p><ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font></li></ol>
         :type AutoJumpBack: bool
-        :param _JumpUrl: 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
+        :param _JumpUrl: <p>签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。</p>
         :type JumpUrl: str
-        :param _Operator: 暂未开放
+        :param _Operator: <p>暂未开放</p>
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
-        :param _Hides: 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
-
-<ul><li> **0** :合同签署页面更多操作按钮</li>
-<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
-<li> **2** :合同签署页面更多操作的转他人处理按钮</li>
-<li> **3** :签署成功页的查看详情按钮</li>
-<li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
-<li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
-
-注:  `字段为数组, 可以传值隐藏多个按钮`
+        :param _Hides: <p>生成的签署链接在签署页面隐藏的按钮列表，可设置如下：</p><ul><li> **0** :合同签署页面更多操作按钮</li><li> **1** :合同签署页面更多操作的拒绝签署按钮</li><li> **2** :合同签署页面更多操作的转他人处理按钮</li><li> **3** :签署成功页的查看详情按钮</li><li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li><li> **5** :合同签署页面更多操作的撤销按钮</li></ul><p>注:  <code>字段为数组, 可以传值隐藏多个按钮</code></p>
         :type Hides: list of int
-        :param _RecipientIds: 参与方角色ID，用于生成动态签署人链接完成领取。
-
-注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
+        :param _RecipientIds: <p>参与方角色ID，用于生成动态签署人链接完成领取。</p><p>注：<code>使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID</code>，</p>
         :type RecipientIds: list of str
-        :param _FlowGroupUrlInfo: 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
+        :param _FlowGroupUrlInfo: <p>合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。</p>
         :type FlowGroupUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupUrlInfo`
-        :param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。 
-
-参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
+        :param _UrlUseEnv: <p><font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 <strong>WeChatOfficialAccounts</strong>，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。 </p><p>参考 <a href="https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC">公众号 H5 跳转电子签小程序</a>。</p>
         :type UrlUseEnv: str
+        :param _CanSkipReadFlow: <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注：<code>1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。</code></p><p>默认值：false</p>
+        :type CanSkipReadFlow: bool
         """
         self._Agent = None
         self._FlowIds = None
@@ -18211,18 +18146,11 @@ class CreateSignUrlsRequest(AbstractModel):
         self._RecipientIds = None
         self._FlowGroupUrlInfo = None
         self._UrlUseEnv = None
+        self._CanSkipReadFlow = None
 
     @property
     def Agent(self):
-        r"""关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
-
-此接口下面信息必填。
-<ul>
-<li>渠道应用标识:  Agent.AppId</li>
-<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
-<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
-</ul>
-第三方平台子客企业和员工必须已经过实名认证
+        r"""<p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识:  Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
         """
         return self._Agent
@@ -18233,11 +18161,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def FlowIds(self):
-        r"""合同流程ID数组，最多支持100个。
-
-注: 
-1. 必须选择提供此参数或合同组编号中的一个。
-2. 当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。
+        r"""<p>合同流程ID数组，最多支持100个。</p><p>注: </p><ol><li>必须选择提供此参数或合同组编号中的一个。</li><li>当生成类型（GenerateType）设为“ALL”时，不可提供多个流程ID。</li></ol>
         :rtype: list of str
         """
         return self._FlowIds
@@ -18248,8 +18172,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def FlowGroupId(self):
-        r"""合同组编号
-注：`该参数和合同流程ID数组必须二选一`
+        r"""<p>合同组编号<br>注：<code>该参数和合同流程ID数组必须二选一</code></p>
         :rtype: str
         """
         return self._FlowGroupId
@@ -18260,16 +18183,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def Endpoint(self):
-        r"""签署链接类型,可以设置的参数如下
-<ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链</li>
-<li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
-<li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
-<li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul>
-
-**注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。
-
-详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
-
+        r"""<p>签署链接类型,可以设置的参数如下</p><ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回短链</li><li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li><li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li><li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul><p><strong>注：</strong>动态签署人场景，如果签署链接类型设置为<code>APP</code>，则仅支持跳转到封面页。</p><p>详细使用场景可以参考接口描述说明中的 <strong>主要使用场景EndPoint分类</strong></p>
         :rtype: str
         """
         return self._Endpoint
@@ -18280,14 +18194,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def GenerateType(self):
-        r"""签署链接生成类型，可以选择的类型如下
-
-<ul><li><strong>ALL</strong>：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：<strong>此中类型不支持多个合同ID（FlowIds）</strong>。</li>
-<li><strong>CHANNEL</strong>：适用于第三方子企业的员工签署方。</li>
-<li><strong>NOT_CHANNEL</strong>：适用于SaaS平台企业的员工签署方。</li>
-<li><strong>PERSON</strong>：适用于个人或自然人签署方。</li>
-<li><strong>FOLLOWER</strong>：适用于关注方，目前指合同的抄送方。</li>
-<li><strong>RECIPIENT</strong>：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。</li></ul>
+        r"""<p>签署链接生成类型，可以选择的类型如下</p><ul><li><strong>ALL</strong>：（默认）为所有签署方生成签署链接，但不包括自动签署（静默签署）的签署方。注意：<strong>此中类型不支持多个合同ID（FlowIds）</strong>。</li><li><strong>CHANNEL</strong>：适用于第三方子企业的员工签署方。</li><li><strong>NOT_CHANNEL</strong>：适用于SaaS平台企业的员工签署方。</li><li><strong>PERSON</strong>：适用于个人或自然人签署方。</li><li><strong>FOLLOWER</strong>：适用于关注方，目前指合同的抄送方。</li><li><strong>RECIPIENT</strong>：根据RecipientId生成对应的签署链接，适用于动态添加签署人的情况。</li></ul>
         :rtype: str
         """
         return self._GenerateType
@@ -18298,7 +18205,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def OrganizationName(self):
-        r"""SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。  注:  `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
+        r"""<p>SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。  注:  <code>1.GenerateType为&quot;NOT_CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署</code></p>
         :rtype: str
         """
         return self._OrganizationName
@@ -18309,10 +18216,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def Name(self):
-        r"""合同流程里边参与方的姓名。
-注: 
-1. `GenerateType为"PERSON"(即个人签署方)时必填`。
-2. `在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
+        r"""<p>合同流程里边参与方的姓名。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;(即个人签署方)时必填</code>。</li><li><code>在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
         :rtype: str
         """
         return self._Name
@@ -18323,10 +18227,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def Mobile(self):
-        r"""合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
-注:  
-1. `GenerateType为"PERSON"或"FOLLOWER"时必填。`
-2. `在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
+        r"""<p>合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>注:  </p><ol><li><code>GenerateType为&quot;PERSON&quot;或&quot;FOLLOWER&quot;时必填。</code></li><li><code>在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
         :rtype: str
         """
         return self._Mobile
@@ -18337,12 +18238,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def IdCardType(self):
-        r"""证件类型，支持以下类型
-<ul><li>ID_CARD : 中国大陆居民身份证</li>
-<li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
-<li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
-
-`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
+        r"""<p>证件类型，支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p><code>注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。</code></p>
         :rtype: str
         """
         return self._IdCardType
@@ -18353,12 +18249,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def IdCardNumber(self):
-        r"""证件号码，应符合以下规则
-<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
-<li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
-<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
-
-`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
+        r"""<p>证件号码，应符合以下规则</p><ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul><p><code>注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></p>
         :rtype: str
         """
         return self._IdCardNumber
@@ -18369,7 +18260,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def OrganizationOpenId(self):
-        r"""第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注:  `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
+        r"""<p>第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注:  <code>1.GenerateType为&quot;CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署</code></p>
         :rtype: str
         """
         return self._OrganizationOpenId
@@ -18380,10 +18271,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def OpenId(self):
-        r"""第三方平台子客企业员工的标识OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人, 仅展示已经实名的经办人信息
-
-注： 
-如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）
+        r"""<p>第三方平台子客企业员工的标识OpenId，GenerateType为&quot;CHANNEL&quot;时可用，指定到具体参与人, 仅展示已经实名的经办人信息</p><p>注：<br>如果传进来的<font color="red">OpenId已经实名并且加入企业， 则忽略Name，IdCardType，IdCardNumber，Mobile这四个入参</font>（会用此OpenId实名的身份证和登录的手机号覆盖）</p>
         :rtype: str
         """
         return self._OpenId
@@ -18394,13 +18282,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def AutoJumpBack(self):
-        r"""签署完成后是否自动回跳
-<ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul>
-
-注: 
-1. 该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效
-2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
-3. <font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font> 
+        r"""<p>签署完成后是否自动回跳</p><ul><li>false：否, 签署完成不会自动跳转回来(默认)</li><li>true：是, 签署完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型（电子签小程序跳转贵方小程序）场景</font> 的签署链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）</font></li></ol>
         :rtype: bool
         """
         return self._AutoJumpBack
@@ -18411,7 +18293,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def JumpUrl(self):
-        r"""签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
+        r"""<p>签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。</p>
         :rtype: str
         """
         return self._JumpUrl
@@ -18424,7 +18306,7 @@ class CreateSignUrlsRequest(AbstractModel):
     def Operator(self):
         warnings.warn("parameter `Operator` is deprecated", DeprecationWarning) 
 
-        r"""暂未开放
+        r"""<p>暂未开放</p>
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
         """
         return self._Operator
@@ -18437,16 +18319,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def Hides(self):
-        r"""生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
-
-<ul><li> **0** :合同签署页面更多操作按钮</li>
-<li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
-<li> **2** :合同签署页面更多操作的转他人处理按钮</li>
-<li> **3** :签署成功页的查看详情按钮</li>
-<li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
-<li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
-
-注:  `字段为数组, 可以传值隐藏多个按钮`
+        r"""<p>生成的签署链接在签署页面隐藏的按钮列表，可设置如下：</p><ul><li> **0** :合同签署页面更多操作按钮</li><li> **1** :合同签署页面更多操作的拒绝签署按钮</li><li> **2** :合同签署页面更多操作的转他人处理按钮</li><li> **3** :签署成功页的查看详情按钮</li><li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li><li> **5** :合同签署页面更多操作的撤销按钮</li></ul><p>注:  <code>字段为数组, 可以传值隐藏多个按钮</code></p>
         :rtype: list of int
         """
         return self._Hides
@@ -18457,9 +18330,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def RecipientIds(self):
-        r"""参与方角色ID，用于生成动态签署人链接完成领取。
-
-注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
+        r"""<p>参与方角色ID，用于生成动态签署人链接完成领取。</p><p>注：<code>使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID</code>，</p>
         :rtype: list of str
         """
         return self._RecipientIds
@@ -18470,7 +18341,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def FlowGroupUrlInfo(self):
-        r"""合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
+        r"""<p>合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。</p>
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupUrlInfo`
         """
         return self._FlowGroupUrlInfo
@@ -18481,9 +18352,7 @@ class CreateSignUrlsRequest(AbstractModel):
 
     @property
     def UrlUseEnv(self):
-        r"""<font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。 
-
-参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。
+        r"""<p><font color="red">仅公众号 H5 跳转电子签小程序时</font>，如需签署完成的“返回应用”功能，在获取签署链接接口的 UrlUseEnv 参数需设置为 <strong>WeChatOfficialAccounts</strong>，小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后，会返回到公众号 H5。 </p><p>参考 <a href="https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC">公众号 H5 跳转电子签小程序</a>。</p>
         :rtype: str
         """
         return self._UrlUseEnv
@@ -18492,6 +18361,17 @@ class CreateSignUrlsRequest(AbstractModel):
     def UrlUseEnv(self, UrlUseEnv):
         self._UrlUseEnv = UrlUseEnv
 
+    @property
+    def CanSkipReadFlow(self):
+        r"""<p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注：<code>1. 此功能为白名单功能，使用前请联系对应客户经理进行开通。2. 使用此功能时，FlowIds参数必传。3. 对于企业签署方，如果对印章/签名控件有限制要求，需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致，否则无法使用此功能。</code></p><p>默认值：false</p>
+        :rtype: bool
+        """
+        return self._CanSkipReadFlow
+
+    @CanSkipReadFlow.setter
+    def CanSkipReadFlow(self, CanSkipReadFlow):
+        self._CanSkipReadFlow = CanSkipReadFlow
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -18519,6 +18399,7 @@ class CreateSignUrlsRequest(AbstractModel):
             self._FlowGroupUrlInfo = FlowGroupUrlInfo()
             self._FlowGroupUrlInfo._deserialize(params.get("FlowGroupUrlInfo"))
         self._UrlUseEnv = params.get("UrlUseEnv")
+        self._CanSkipReadFlow = params.get("CanSkipReadFlow")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -18536,9 +18417,9 @@ class CreateSignUrlsResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _SignUrlInfos: 生成的签署参与者的签署链接信息数组。
+        :param _SignUrlInfos: <p>生成的签署参与者的签署链接信息数组。</p>
         :type SignUrlInfos: list of SignUrlInfo
-        :param _ErrorMessages: 生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致
+        :param _ErrorMessages: <p>生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致</p>
         :type ErrorMessages: list of str
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
@@ -18549,7 +18430,7 @@ class CreateSignUrlsResponse(AbstractModel):
 
     @property
     def SignUrlInfos(self):
-        r"""生成的签署参与者的签署链接信息数组。
+        r"""<p>生成的签署参与者的签署链接信息数组。</p>
         :rtype: list of SignUrlInfo
         """
         return self._SignUrlInfos
@@ -18560,7 +18441,7 @@ class CreateSignUrlsResponse(AbstractModel):
 
     @property
     def ErrorMessages(self):
-        r"""生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致
+        r"""<p>生成失败时的错误信息，成功返回”“，顺序和出参SignUrlInfos保持一致</p>
         :rtype: list of str
         """
         return self._ErrorMessages

{tencentcloud_sdk_python_essbasic-3.1.58.dist-info → tencentcloud_sdk_python_essbasic-3.1.59.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.1.58
+Version: 3.1.59
 Summary: Tencent Cloud Essbasic 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.58
+Requires-Dist: tencentcloud-sdk-python-common <4.0.0,>=3.1.59
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_essbasic-3.1.58.dist-info → tencentcloud_sdk_python_essbasic-3.1.59.dist-info}/RECORD

@@ -1,4 +1,4 @@
-tencentcloud/__init__.py,sha256=80mqw7bC5ozl_dfaDznU7cuqTKRLPTJceB2mosAGZ2I,629
+tencentcloud/__init__.py,sha256=GVKa6_cNf9AZ1e3y8dYgDfWF9LE1xZJtLNMz5mJnfEk,629
 tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/errorcodes.py,sha256=_HaXGynY1ocz-dbY7C6IOlNUWmNMu9XsY-x11g3Rm-w,5365
@@ -9,8 +9,8 @@ tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 tencentcloud/essbasic/v20210526/errorcodes.py,sha256=4Cs5syJZPMDlJQ8jT1hxH-gj5BrvgIKo7VBrrcRDvsk,19287
 tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=mHJPsv67i9uSTX9a3Jj51imMkkXj6ZwLHMSM9HG__qw,176085
 tencentcloud/essbasic/v20210526/essbasic_client_async.py,sha256=cmw5Q8LtnUXTFoVCDpJcHjTbevWwaI78pM7RSBR2_1s,146074
-tencentcloud/essbasic/v20210526/models.py,sha256=C48iKv6lm2h1e9DbRrOQ82gfnpvW80R1cnOortP6jdE,1372070
-tencentcloud_sdk_python_essbasic-3.1.58.dist-info/METADATA,sha256=SYExc0UGnCGkjGpfW7kJjSvwE1t2rVUwKtwuTRP7FTM,1520
-tencentcloud_sdk_python_essbasic-3.1.58.dist-info/WHEEL,sha256=a5ogxI61vGGBHYbAAwISCXsfU7mxKr76gTpCEmSNOI8,109
-tencentcloud_sdk_python_essbasic-3.1.58.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
-tencentcloud_sdk_python_essbasic-3.1.58.dist-info/RECORD,,
+tencentcloud/essbasic/v20210526/models.py,sha256=2ZqA-t9MNw-YBsZenCYe0SB6TuJ-Ct2AycMvftSQsJo,1374699
+tencentcloud_sdk_python_essbasic-3.1.59.dist-info/METADATA,sha256=ujSG7YzKpDDQAMSsxGhbFDGg4qq22IkAa2I_OArg6bY,1520
+tencentcloud_sdk_python_essbasic-3.1.59.dist-info/WHEEL,sha256=a5ogxI61vGGBHYbAAwISCXsfU7mxKr76gTpCEmSNOI8,109
+tencentcloud_sdk_python_essbasic-3.1.59.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
+tencentcloud_sdk_python_essbasic-3.1.59.dist-info/RECORD,,