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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
tencentcloud/__init__.py CHANGED
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.51'
17
+ __version__ = '3.1.59'
@@ -4530,6 +4530,8 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4530
4530
  :type OpenDynamicFlow: bool
4531
4531
  :param _OpenDynamicSignFlow: <p>是否开启动态合同(动态签署人2.0)<ul><li> <strong>false</strong> :(默认) 不开启动态合同(动态签署人2.0)</li><li> <strong>true</strong> :开启动态合同(动态签署人2.0),发起时不设置签署方,发起后可继续追加合同签署人</li></ul></p>
4532
4532
  :type OpenDynamicSignFlow: bool
4533
+ :param _FlowOperateLimit: <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
4534
+ :type FlowOperateLimit: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
4533
4535
  """
4534
4536
  self._Agent = None
4535
4537
  self._FlowName = None
@@ -4555,6 +4557,7 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4555
4557
  self._PreviewType = None
4556
4558
  self._OpenDynamicFlow = None
4557
4559
  self._OpenDynamicSignFlow = None
4560
+ self._FlowOperateLimit = None
4558
4561
 
4559
4562
  @property
4560
4563
  def Agent(self):
@@ -4832,6 +4835,17 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4832
4835
  def OpenDynamicSignFlow(self, OpenDynamicSignFlow):
4833
4836
  self._OpenDynamicSignFlow = OpenDynamicSignFlow
4834
4837
 
4838
+ @property
4839
+ def FlowOperateLimit(self):
4840
+ r"""<p>发起合同流程时对合同流程的部分操作加以限制的配置。</p>
4841
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
4842
+ """
4843
+ return self._FlowOperateLimit
4844
+
4845
+ @FlowOperateLimit.setter
4846
+ def FlowOperateLimit(self, FlowOperateLimit):
4847
+ self._FlowOperateLimit = FlowOperateLimit
4848
+
4835
4849
 
4836
4850
  def _deserialize(self, params):
4837
4851
  if params.get("Agent") is not None:
@@ -4877,6 +4891,9 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
4877
4891
  self._PreviewType = params.get("PreviewType")
4878
4892
  self._OpenDynamicFlow = params.get("OpenDynamicFlow")
4879
4893
  self._OpenDynamicSignFlow = params.get("OpenDynamicSignFlow")
4894
+ if params.get("FlowOperateLimit") is not None:
4895
+ self._FlowOperateLimit = FlowOperateLimit()
4896
+ self._FlowOperateLimit._deserialize(params.get("FlowOperateLimit"))
4880
4897
  memeber_set = set(params.keys())
4881
4898
  for name, value in vars(self).items():
4882
4899
  property_name = name[1:]
@@ -18069,111 +18086,46 @@ class CreateSignUrlsRequest(AbstractModel):
18069
18086
 
18070
18087
  def __init__(self):
18071
18088
  r"""
18072
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
18073
-
18074
- 此接口下面信息必填。
18075
- <ul>
18076
- <li>渠道应用标识: Agent.AppId</li>
18077
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
18078
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
18079
- </ul>
18080
- 第三方平台子客企业和员工必须已经过实名认证
18089
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
18081
18090
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
18082
- :param _FlowIds: 合同流程ID数组,最多支持100个。
18083
-
18084
- 注:
18085
- 1. 必须选择提供此参数或合同组编号中的一个。
18086
- 2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。
18091
+ :param _FlowIds: <p>合同流程ID数组,最多支持100个。</p><p>注: </p><ol><li>必须选择提供此参数或合同组编号中的一个。</li><li>当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。</li></ol>
18087
18092
  :type FlowIds: list of str
18088
- :param _FlowGroupId: 合同组编号
18089
- 注:`该参数和合同流程ID数组必须二选一`
18093
+ :param _FlowGroupId: <p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
18090
18094
  :type FlowGroupId: str
18091
- :param _Endpoint: 签署链接类型,可以设置的参数如下
18092
- <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
18093
- <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
18094
- <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
18095
- <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
18096
-
18097
- **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
18098
-
18099
- 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
18100
-
18095
+ :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>
18101
18096
  :type Endpoint: str
18102
- :param _GenerateType: 签署链接生成类型,可以选择的类型如下
18103
-
18104
- <ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li>
18105
- <li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li>
18106
- <li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li>
18107
- <li><strong>PERSON</strong>:适用于个人或自然人签署方。</li>
18108
- <li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li>
18109
- <li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
18097
+ :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>
18110
18098
  :type GenerateType: str
18111
- :param _OrganizationName: SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
18099
+ :param _OrganizationName: <p>SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: <code>1.GenerateType为&quot;NOT_CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署</code></p>
18112
18100
  :type OrganizationName: str
18113
- :param _Name: 合同流程里边参与方的姓名。
18114
- 注:
18115
- 1. `GenerateType为"PERSON"(即个人签署方)时必填`。
18116
- 2. `在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
18101
+ :param _Name: <p>合同流程里边参与方的姓名。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;(即个人签署方)时必填</code>。</li><li><code>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
18117
18102
  :type Name: str
18118
- :param _Mobile: 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)
18119
- 注:
18120
- 1. `GenerateType为"PERSON"或"FOLLOWER"时必填。`
18121
- 2. `在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
18103
+ :param _Mobile: <p>合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;或&quot;FOLLOWER&quot;时必填。</code></li><li><code>在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
18122
18104
  :type Mobile: str
18123
- :param _IdCardType: 证件类型,支持以下类型
18124
- <ul><li>ID_CARD : 中国大陆居民身份证</li>
18125
- <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
18126
- <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
18127
-
18128
- `注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
18105
+ :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>
18129
18106
  :type IdCardType: str
18130
- :param _IdCardNumber: 证件号码,应符合以下规则
18131
- <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
18132
- <li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
18133
- <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
18134
-
18135
- `注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
18107
+ :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>
18136
18108
  :type IdCardNumber: str
18137
- :param _OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
18109
+ :param _OrganizationOpenId: <p>第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: <code>1.GenerateType为&quot;CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署</code></p>
18138
18110
  :type OrganizationOpenId: str
18139
- :param _OpenId: 第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
18140
-
18141
- 注:
18142
- 如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)
18111
+ :param _OpenId: <p>第三方平台子客企业员工的标识OpenId,GenerateType为&quot;CHANNEL&quot;时可用,指定到具体参与人, 仅展示已经实名的经办人信息</p><p>注:<br>如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)</p>
18143
18112
  :type OpenId: str
18144
- :param _AutoJumpBack: 签署完成后是否自动回跳
18145
- <ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
18146
-
18147
- 注:
18148
- 1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
18149
- 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
18150
- 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
18113
+ :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>
18151
18114
  :type AutoJumpBack: bool
18152
- :param _JumpUrl: 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
18115
+ :param _JumpUrl: <p>签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。</p>
18153
18116
  :type JumpUrl: str
18154
- :param _Operator: 暂未开放
18117
+ :param _Operator: <p>暂未开放</p>
18155
18118
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
18156
- :param _Hides: 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
18157
-
18158
- <ul><li> **0** :合同签署页面更多操作按钮</li>
18159
- <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
18160
- <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
18161
- <li> **3** :签署成功页的查看详情按钮</li>
18162
- <li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
18163
- <li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
18164
-
18165
- 注: `字段为数组, 可以传值隐藏多个按钮`
18119
+ :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>
18166
18120
  :type Hides: list of int
18167
- :param _RecipientIds: 参与方角色ID,用于生成动态签署人链接完成领取。
18168
-
18169
- 注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,
18121
+ :param _RecipientIds: <p>参与方角色ID,用于生成动态签署人链接完成领取。</p><p>注:<code>使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID</code>,</p>
18170
18122
  :type RecipientIds: list of str
18171
- :param _FlowGroupUrlInfo: 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
18123
+ :param _FlowGroupUrlInfo: <p>合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。</p>
18172
18124
  :type FlowGroupUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupUrlInfo`
18173
- :param _UrlUseEnv: <font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
18174
-
18175
- 参考 [公众号 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)。
18125
+ :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>
18176
18126
  :type UrlUseEnv: str
18127
+ :param _CanSkipReadFlow: <p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。</code></p><p>默认值:false</p>
18128
+ :type CanSkipReadFlow: bool
18177
18129
  """
18178
18130
  self._Agent = None
18179
18131
  self._FlowIds = None
@@ -18194,18 +18146,11 @@ class CreateSignUrlsRequest(AbstractModel):
18194
18146
  self._RecipientIds = None
18195
18147
  self._FlowGroupUrlInfo = None
18196
18148
  self._UrlUseEnv = None
18149
+ self._CanSkipReadFlow = None
18197
18150
 
18198
18151
  @property
18199
18152
  def Agent(self):
18200
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
18201
-
18202
- 此接口下面信息必填。
18203
- <ul>
18204
- <li>渠道应用标识: Agent.AppId</li>
18205
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
18206
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
18207
- </ul>
18208
- 第三方平台子客企业和员工必须已经过实名认证
18153
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
18209
18154
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
18210
18155
  """
18211
18156
  return self._Agent
@@ -18216,11 +18161,7 @@ class CreateSignUrlsRequest(AbstractModel):
18216
18161
 
18217
18162
  @property
18218
18163
  def FlowIds(self):
18219
- r"""合同流程ID数组,最多支持100个。
18220
-
18221
- 注:
18222
- 1. 必须选择提供此参数或合同组编号中的一个。
18223
- 2. 当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。
18164
+ r"""<p>合同流程ID数组,最多支持100个。</p><p>注: </p><ol><li>必须选择提供此参数或合同组编号中的一个。</li><li>当生成类型(GenerateType)设为“ALL”时,不可提供多个流程ID。</li></ol>
18224
18165
  :rtype: list of str
18225
18166
  """
18226
18167
  return self._FlowIds
@@ -18231,8 +18172,7 @@ class CreateSignUrlsRequest(AbstractModel):
18231
18172
 
18232
18173
  @property
18233
18174
  def FlowGroupId(self):
18234
- r"""合同组编号
18235
- 注:`该参数和合同流程ID数组必须二选一`
18175
+ r"""<p>合同组编号<br>注:<code>该参数和合同流程ID数组必须二选一</code></p>
18236
18176
  :rtype: str
18237
18177
  """
18238
18178
  return self._FlowGroupId
@@ -18243,16 +18183,7 @@ class CreateSignUrlsRequest(AbstractModel):
18243
18183
 
18244
18184
  @property
18245
18185
  def Endpoint(self):
18246
- r"""签署链接类型,可以设置的参数如下
18247
- <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
18248
- <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接(<b>GenerateType非ALL时候不能设置成CHANNEL</b>)</li>
18249
- <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
18250
- <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
18251
-
18252
- **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
18253
-
18254
- 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
18255
-
18186
+ 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>
18256
18187
  :rtype: str
18257
18188
  """
18258
18189
  return self._Endpoint
@@ -18263,14 +18194,7 @@ class CreateSignUrlsRequest(AbstractModel):
18263
18194
 
18264
18195
  @property
18265
18196
  def GenerateType(self):
18266
- r"""签署链接生成类型,可以选择的类型如下
18267
-
18268
- <ul><li><strong>ALL</strong>:(默认)为所有签署方生成签署链接,但不包括自动签署(静默签署)的签署方。注意:<strong>此中类型不支持多个合同ID(FlowIds)</strong>。</li>
18269
- <li><strong>CHANNEL</strong>:适用于第三方子企业的员工签署方。</li>
18270
- <li><strong>NOT_CHANNEL</strong>:适用于SaaS平台企业的员工签署方。</li>
18271
- <li><strong>PERSON</strong>:适用于个人或自然人签署方。</li>
18272
- <li><strong>FOLLOWER</strong>:适用于关注方,目前指合同的抄送方。</li>
18273
- <li><strong>RECIPIENT</strong>:根据RecipientId生成对应的签署链接,适用于动态添加签署人的情况。</li></ul>
18197
+ 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>
18274
18198
  :rtype: str
18275
18199
  """
18276
18200
  return self._GenerateType
@@ -18281,7 +18205,7 @@ class CreateSignUrlsRequest(AbstractModel):
18281
18205
 
18282
18206
  @property
18283
18207
  def OrganizationName(self):
18284
- r"""SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
18208
+ r"""<p>SaaS平台企业员工签署方的企业名称如果名称中包含英文括号(),请使用中文括号()代替。 注: <code>1.GenerateType为&quot;NOT_CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署</code></p>
18285
18209
  :rtype: str
18286
18210
  """
18287
18211
  return self._OrganizationName
@@ -18292,10 +18216,7 @@ class CreateSignUrlsRequest(AbstractModel):
18292
18216
 
18293
18217
  @property
18294
18218
  def Name(self):
18295
- r"""合同流程里边参与方的姓名。
18296
- 注:
18297
- 1. `GenerateType为"PERSON"(即个人签署方)时必填`。
18298
- 2. `在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
18219
+ r"""<p>合同流程里边参与方的姓名。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;(即个人签署方)时必填</code>。</li><li><code>在动态签署人补充链接场景中,可以通过传入这个值,对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
18299
18220
  :rtype: str
18300
18221
  """
18301
18222
  return self._Name
@@ -18306,10 +18227,7 @@ class CreateSignUrlsRequest(AbstractModel):
18306
18227
 
18307
18228
  @property
18308
18229
  def Mobile(self):
18309
- r"""合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)
18310
- 注:
18311
- 1. `GenerateType为"PERSON"或"FOLLOWER"时必填。`
18312
- 2. `在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
18230
+ r"""<p>合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。<br>注: </p><ol><li><code>GenerateType为&quot;PERSON&quot;或&quot;FOLLOWER&quot;时必填。</code></li><li><code>在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</code></li></ol>
18313
18231
  :rtype: str
18314
18232
  """
18315
18233
  return self._Mobile
@@ -18320,12 +18238,7 @@ class CreateSignUrlsRequest(AbstractModel):
18320
18238
 
18321
18239
  @property
18322
18240
  def IdCardType(self):
18323
- r"""证件类型,支持以下类型
18324
- <ul><li>ID_CARD : 中国大陆居民身份证</li>
18325
- <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
18326
- <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
18327
-
18328
- `注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。`
18241
+ r"""<p>证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p><code>注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方,且需要和证件号参数一同传递,不能单独进行限制。</code></p>
18329
18242
  :rtype: str
18330
18243
  """
18331
18244
  return self._IdCardType
@@ -18336,12 +18249,7 @@ class CreateSignUrlsRequest(AbstractModel):
18336
18249
 
18337
18250
  @property
18338
18251
  def IdCardNumber(self):
18339
- r"""证件号码,应符合以下规则
18340
- <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
18341
- <li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
18342
- <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
18343
-
18344
- `注:在动态签署人补充链接场景中,可以通过传入此值,对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
18252
+ 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>
18345
18253
  :rtype: str
18346
18254
  """
18347
18255
  return self._IdCardNumber
@@ -18352,7 +18260,7 @@ class CreateSignUrlsRequest(AbstractModel):
18352
18260
 
18353
18261
  @property
18354
18262
  def OrganizationOpenId(self):
18355
- r"""第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
18263
+ r"""<p>第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注: <code>1.GenerateType为&quot;CHANNEL&quot;时必填</code> <code>2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署</code></p>
18356
18264
  :rtype: str
18357
18265
  """
18358
18266
  return self._OrganizationOpenId
@@ -18363,10 +18271,7 @@ class CreateSignUrlsRequest(AbstractModel):
18363
18271
 
18364
18272
  @property
18365
18273
  def OpenId(self):
18366
- r"""第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
18367
-
18368
- 注:
18369
- 如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)
18274
+ r"""<p>第三方平台子客企业员工的标识OpenId,GenerateType为&quot;CHANNEL&quot;时可用,指定到具体参与人, 仅展示已经实名的经办人信息</p><p>注:<br>如果传进来的<font color="red">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)</p>
18370
18275
  :rtype: str
18371
18276
  """
18372
18277
  return self._OpenId
@@ -18377,13 +18282,7 @@ class CreateSignUrlsRequest(AbstractModel):
18377
18282
 
18378
18283
  @property
18379
18284
  def AutoJumpBack(self):
18380
- r"""签署完成后是否自动回跳
18381
- <ul><li>false:否, 签署完成不会自动跳转回来(默认)</li><li>true:是, 签署完成会自动跳转回来</li></ul>
18382
-
18383
- 注:
18384
- 1. 该参数<font color="red">只针对APP类型(电子签小程序跳转贵方小程序)场景</font> 的签署链接有效
18385
- 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
18386
- 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
18285
+ 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>
18387
18286
  :rtype: bool
18388
18287
  """
18389
18288
  return self._AutoJumpBack
@@ -18394,7 +18293,7 @@ class CreateSignUrlsRequest(AbstractModel):
18394
18293
 
18395
18294
  @property
18396
18295
  def JumpUrl(self):
18397
- r"""签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
18296
+ r"""<p>签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。</p>
18398
18297
  :rtype: str
18399
18298
  """
18400
18299
  return self._JumpUrl
@@ -18407,7 +18306,7 @@ class CreateSignUrlsRequest(AbstractModel):
18407
18306
  def Operator(self):
18408
18307
  warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
18409
18308
 
18410
- r"""暂未开放
18309
+ r"""<p>暂未开放</p>
18411
18310
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
18412
18311
  """
18413
18312
  return self._Operator
@@ -18420,16 +18319,7 @@ class CreateSignUrlsRequest(AbstractModel):
18420
18319
 
18421
18320
  @property
18422
18321
  def Hides(self):
18423
- r"""生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
18424
-
18425
- <ul><li> **0** :合同签署页面更多操作按钮</li>
18426
- <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
18427
- <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
18428
- <li> **3** :签署成功页的查看详情按钮</li>
18429
- <li> **4** :合同签署页面更多操作的查看合同基本信息按钮</li>
18430
- <li> **5** :合同签署页面更多操作的撤销按钮</li></ul>
18431
-
18432
- 注: `字段为数组, 可以传值隐藏多个按钮`
18322
+ 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>
18433
18323
  :rtype: list of int
18434
18324
  """
18435
18325
  return self._Hides
@@ -18440,9 +18330,7 @@ class CreateSignUrlsRequest(AbstractModel):
18440
18330
 
18441
18331
  @property
18442
18332
  def RecipientIds(self):
18443
- r"""参与方角色ID,用于生成动态签署人链接完成领取。
18444
-
18445
- 注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,
18333
+ r"""<p>参与方角色ID,用于生成动态签署人链接完成领取。</p><p>注:<code>使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID</code>,</p>
18446
18334
  :rtype: list of str
18447
18335
  """
18448
18336
  return self._RecipientIds
@@ -18453,7 +18341,7 @@ class CreateSignUrlsRequest(AbstractModel):
18453
18341
 
18454
18342
  @property
18455
18343
  def FlowGroupUrlInfo(self):
18456
- r"""合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
18344
+ r"""<p>合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。</p>
18457
18345
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowGroupUrlInfo`
18458
18346
  """
18459
18347
  return self._FlowGroupUrlInfo
@@ -18464,9 +18352,7 @@ class CreateSignUrlsRequest(AbstractModel):
18464
18352
 
18465
18353
  @property
18466
18354
  def UrlUseEnv(self):
18467
- r"""<font color="red">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。
18468
-
18469
- 参考 [公众号 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)。
18355
+ 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>
18470
18356
  :rtype: str
18471
18357
  """
18472
18358
  return self._UrlUseEnv
@@ -18475,6 +18361,17 @@ class CreateSignUrlsRequest(AbstractModel):
18475
18361
  def UrlUseEnv(self, UrlUseEnv):
18476
18362
  self._UrlUseEnv = UrlUseEnv
18477
18363
 
18364
+ @property
18365
+ def CanSkipReadFlow(self):
18366
+ r"""<p>是否允许此链接中签署方批量确认已读文件。 <ul><li>false (默认): 不允许批量确认已读文件。</li> <li>true : 允许批量确认已读文件。</li></ul> 注:<code>1. 此功能为白名单功能,使用前请联系对应客户经理进行开通。2. 使用此功能时,FlowIds参数必传。3. 对于企业签署方,如果对印章/签名控件有限制要求,需要保证所有印章/签名签署控件限制要求(印章id或印章/签名类型限制)一致,否则无法使用此功能。</code></p><p>默认值:false</p>
18367
+ :rtype: bool
18368
+ """
18369
+ return self._CanSkipReadFlow
18370
+
18371
+ @CanSkipReadFlow.setter
18372
+ def CanSkipReadFlow(self, CanSkipReadFlow):
18373
+ self._CanSkipReadFlow = CanSkipReadFlow
18374
+
18478
18375
 
18479
18376
  def _deserialize(self, params):
18480
18377
  if params.get("Agent") is not None:
@@ -18502,6 +18399,7 @@ class CreateSignUrlsRequest(AbstractModel):
18502
18399
  self._FlowGroupUrlInfo = FlowGroupUrlInfo()
18503
18400
  self._FlowGroupUrlInfo._deserialize(params.get("FlowGroupUrlInfo"))
18504
18401
  self._UrlUseEnv = params.get("UrlUseEnv")
18402
+ self._CanSkipReadFlow = params.get("CanSkipReadFlow")
18505
18403
  memeber_set = set(params.keys())
18506
18404
  for name, value in vars(self).items():
18507
18405
  property_name = name[1:]
@@ -18519,9 +18417,9 @@ class CreateSignUrlsResponse(AbstractModel):
18519
18417
 
18520
18418
  def __init__(self):
18521
18419
  r"""
18522
- :param _SignUrlInfos: 生成的签署参与者的签署链接信息数组。
18420
+ :param _SignUrlInfos: <p>生成的签署参与者的签署链接信息数组。</p>
18523
18421
  :type SignUrlInfos: list of SignUrlInfo
18524
- :param _ErrorMessages: 生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
18422
+ :param _ErrorMessages: <p>生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致</p>
18525
18423
  :type ErrorMessages: list of str
18526
18424
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
18527
18425
  :type RequestId: str
@@ -18532,7 +18430,7 @@ class CreateSignUrlsResponse(AbstractModel):
18532
18430
 
18533
18431
  @property
18534
18432
  def SignUrlInfos(self):
18535
- r"""生成的签署参与者的签署链接信息数组。
18433
+ r"""<p>生成的签署参与者的签署链接信息数组。</p>
18536
18434
  :rtype: list of SignUrlInfo
18537
18435
  """
18538
18436
  return self._SignUrlInfos
@@ -18543,7 +18441,7 @@ class CreateSignUrlsResponse(AbstractModel):
18543
18441
 
18544
18442
  @property
18545
18443
  def ErrorMessages(self):
18546
- r"""生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致
18444
+ r"""<p>生成失败时的错误信息,成功返回”“,顺序和出参SignUrlInfos保持一致</p>
18547
18445
  :rtype: list of str
18548
18446
  """
18549
18447
  return self._ErrorMessages
@@ -24339,85 +24237,38 @@ class FlowInfo(AbstractModel):
24339
24237
 
24340
24238
  def __init__(self):
24341
24239
  r"""
24342
- :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
24240
+ :param _FlowName: <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
24343
24241
  :type FlowName: str
24344
- :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
24345
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
24346
- 示例值:1604912664
24242
+ :param _Deadline: <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。<br>示例值:1604912664</p>
24347
24243
  :type Deadline: int
24348
- :param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
24349
- 如果使用模板发起接口,此参数为必填。
24350
-
24351
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
24352
-
24353
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
24354
-
24244
+ :param _TemplateId: <p>用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。<br>如果使用模板发起接口,此参数为必填。</p><p>可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在<strong>企业模板</strong>中得到合同模板ID。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png">点击产看模板Id在控制台上的位置</a></p>
24355
24245
  :type TemplateId: str
24356
- :param _FlowApprovers: 合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
24357
-
24358
- 注:
24359
- <font color="red" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
24360
- 例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
24361
-
24362
- [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
24363
-
24246
+ :param _FlowApprovers: <p>合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a></p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png">点击查看模板参与人顺序定义位置</a></p>
24364
24247
  :type FlowApprovers: list of FlowApproverInfo
24365
- :param _FormFields: 发起方角色的填写控件的填充内容。
24366
-
24367
- 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。
24368
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
24248
+ :param _FormFields: <p>发起方角色的填写控件的填充内容。</p><p>注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png" alt="image"></p>
24369
24249
  :type FormFields: list of FormField
24370
- :param _CallbackUrl: 该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
24250
+ :param _CallbackUrl: <p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
24371
24251
  :type CallbackUrl: str
24372
- :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
24252
+ :param _FlowType: <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
24373
24253
  :type FlowType: str
24374
- :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
24254
+ :param _FlowDescription: <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
24375
24255
  :type FlowDescription: str
24376
- :param _CustomerData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
24377
-
24378
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
24256
+ :param _CustomerData: <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
24379
24257
  :type CustomerData: str
24380
- :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
24381
- <ul><li>{合同名称} </li>
24382
- <li>{发起方企业} </li>
24383
- <li>{发起方姓名} </li>
24384
- <li>{签署方N企业}</li>
24385
- <li>{签署方N姓名}</li></ul>
24386
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
24387
-
24388
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
24389
-
24390
- 合同名称:租房合同
24391
- 发起方:腾讯公司(张三)
24392
- 签署方:李四
24393
-
24394
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
24395
-
24258
+ :param _CustomShowMap: <p>您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
24396
24259
  :type CustomShowMap: str
24397
- :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
24398
-
24399
- <b>注</b>
24400
- 1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
24401
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
24260
+ :param _CcInfos: <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
24402
24261
  :type CcInfos: list of CcInfo
24403
- :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
24404
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
24405
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
24406
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
24407
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
24408
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
24409
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
24262
+ :param _NeedSignReview: <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
24410
24263
  :type NeedSignReview: bool
24411
- :param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
24412
- <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
24413
- <li> **1** : 签署完成后通知对方来查看合同</li></ul>
24264
+ :param _CcNotifyType: <p>若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:</p><ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li><li> **1** : 签署完成后通知对方来查看合同</li></ul>
24414
24265
  :type CcNotifyType: int
24415
- :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
24416
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
24417
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
24266
+ :param _AutoSignScene: <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
24418
24267
  :type AutoSignScene: str
24419
- :param _FlowDisplayType: 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
24268
+ :param _FlowDisplayType: <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
24420
24269
  :type FlowDisplayType: int
24270
+ :param _FlowOperateLimit: <p>发起合同流程时对合同流程的部分操作加以限制的配置。</p><p> 注:此参数目前<strong>只支持 CreateFlowsByTemplates接口</strong> 。</p>
24271
+ :type FlowOperateLimit: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
24421
24272
  """
24422
24273
  self._FlowName = None
24423
24274
  self._Deadline = None
@@ -24434,10 +24285,11 @@ class FlowInfo(AbstractModel):
24434
24285
  self._CcNotifyType = None
24435
24286
  self._AutoSignScene = None
24436
24287
  self._FlowDisplayType = None
24288
+ self._FlowOperateLimit = None
24437
24289
 
24438
24290
  @property
24439
24291
  def FlowName(self):
24440
- r"""合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
24292
+ r"""<p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
24441
24293
  :rtype: str
24442
24294
  """
24443
24295
  return self._FlowName
@@ -24448,9 +24300,7 @@ class FlowInfo(AbstractModel):
24448
24300
 
24449
24301
  @property
24450
24302
  def Deadline(self):
24451
- r"""合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
24452
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
24453
- 示例值:1604912664
24303
+ r"""<p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。<br>示例值:1604912664</p>
24454
24304
  :rtype: int
24455
24305
  """
24456
24306
  return self._Deadline
@@ -24461,13 +24311,7 @@ class FlowInfo(AbstractModel):
24461
24311
 
24462
24312
  @property
24463
24313
  def TemplateId(self):
24464
- r"""用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
24465
- 如果使用模板发起接口,此参数为必填。
24466
-
24467
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
24468
-
24469
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
24470
-
24314
+ r"""<p>用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。<br>如果使用模板发起接口,此参数为必填。</p><p>可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在<strong>企业模板</strong>中得到合同模板ID。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png">点击产看模板Id在控制台上的位置</a></p>
24471
24315
  :rtype: str
24472
24316
  """
24473
24317
  return self._TemplateId
@@ -24478,14 +24322,7 @@ class FlowInfo(AbstractModel):
24478
24322
 
24479
24323
  @property
24480
24324
  def FlowApprovers(self):
24481
- r"""合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)
24482
-
24483
- 注:
24484
- <font color="red" > <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。
24485
- 例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font>
24486
-
24487
- [点击查看模板参与人顺序定义位置](https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png)
24488
-
24325
+ r"""<p>合同流程的参与方列表,最多可支持50个参与方。对应不同签署人的传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a></p><p>注:<br><font color="red"> <b> 在发起流程时,需要保证 FlowApprovers中的顺序与模板定义顺序一致,否则会发起失败。<br>例如,如果模板中定义的第一个参与人是个人用户,第二个参与人是企业员工,则在 approver 中传参时,第一个也必须是个人用户,第二个参与人必须是企业员工。</b></font></p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/c50e0a204fc5c66aaa2ca70e451ef2d6.png">点击查看模板参与人顺序定义位置</a></p>
24489
24326
  :rtype: list of FlowApproverInfo
24490
24327
  """
24491
24328
  return self._FlowApprovers
@@ -24496,10 +24333,7 @@ class FlowInfo(AbstractModel):
24496
24333
 
24497
24334
  @property
24498
24335
  def FormFields(self):
24499
- r"""发起方角色的填写控件的填充内容。
24500
-
24501
- 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。
24502
- ![image](https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png)
24336
+ r"""<p>发起方角色的填写控件的填充内容。</p><p>注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。(<font color="red">白名单功能需要联系对接经理开通,否则模板编辑时无法将填写控件分配给发起方</font>)。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/b1d3978140ee2b44e2c9fdc96e467a5d.png" alt="image"></p>
24503
24337
  :rtype: list of FormField
24504
24338
  """
24505
24339
  return self._FormFields
@@ -24512,7 +24346,7 @@ class FlowInfo(AbstractModel):
24512
24346
  def CallbackUrl(self):
24513
24347
  warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
24514
24348
 
24515
- r"""该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息
24349
+ r"""<p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
24516
24350
  :rtype: str
24517
24351
  """
24518
24352
  return self._CallbackUrl
@@ -24525,7 +24359,7 @@ class FlowInfo(AbstractModel):
24525
24359
 
24526
24360
  @property
24527
24361
  def FlowType(self):
24528
- r"""合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
24362
+ r"""<p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
24529
24363
  :rtype: str
24530
24364
  """
24531
24365
  return self._FlowType
@@ -24536,7 +24370,7 @@ class FlowInfo(AbstractModel):
24536
24370
 
24537
24371
  @property
24538
24372
  def FlowDescription(self):
24539
- r"""合同流程描述信息(可自定义此描述),最大长度1000个字符。
24373
+ r"""<p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
24540
24374
  :rtype: str
24541
24375
  """
24542
24376
  return self._FlowDescription
@@ -24547,9 +24381,7 @@ class FlowInfo(AbstractModel):
24547
24381
 
24548
24382
  @property
24549
24383
  def CustomerData(self):
24550
- r"""调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
24551
-
24552
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
24384
+ r"""<p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
24553
24385
  :rtype: str
24554
24386
  """
24555
24387
  return self._CustomerData
@@ -24560,22 +24392,7 @@ class FlowInfo(AbstractModel):
24560
24392
 
24561
24393
  @property
24562
24394
  def CustomShowMap(self):
24563
- r"""您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
24564
- <ul><li>{合同名称} </li>
24565
- <li>{发起方企业} </li>
24566
- <li>{发起方姓名} </li>
24567
- <li>{签署方N企业}</li>
24568
- <li>{签署方N姓名}</li></ul>
24569
- 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
24570
-
24571
- 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
24572
-
24573
- 合同名称:租房合同
24574
- 发起方:腾讯公司(张三)
24575
- 签署方:李四
24576
-
24577
- ![image](https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png)
24578
-
24395
+ r"""<p>您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:</p><ul><li>{合同名称} </li><li>{发起方企业} </li><li>{发起方姓名} </li><li>{签署方N企业}</li><li>{签署方N姓名}</li></ul>其中,N表示签署方的编号,从1开始,不能超过签署人的数量。<p>例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:<code>合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}</code>,则小程序中列表页展示此合同为以下样子</p><p>合同名称:租房合同<br>发起方:腾讯公司(张三)<br>签署方:李四</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/628f0928cac15d2e3bfa6088f53f5998.png" alt="image"></p>
24579
24396
  :rtype: str
24580
24397
  """
24581
24398
  return self._CustomShowMap
@@ -24586,11 +24403,7 @@ class FlowInfo(AbstractModel):
24586
24403
 
24587
24404
  @property
24588
24405
  def CcInfos(self):
24589
- r"""合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
24590
-
24591
- <b>注</b>
24592
- 1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
24593
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
24406
+ r"""<p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
24594
24407
  :rtype: list of CcInfo
24595
24408
  """
24596
24409
  return self._CcInfos
@@ -24601,13 +24414,7 @@ class FlowInfo(AbstractModel):
24601
24414
 
24602
24415
  @property
24603
24416
  def NeedSignReview(self):
24604
- r"""发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
24605
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
24606
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
24607
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
24608
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
24609
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
24610
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
24417
+ r"""<p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
24611
24418
  :rtype: bool
24612
24419
  """
24613
24420
  return self._NeedSignReview
@@ -24618,9 +24425,7 @@ class FlowInfo(AbstractModel):
24618
24425
 
24619
24426
  @property
24620
24427
  def CcNotifyType(self):
24621
- r"""若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
24622
- <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
24623
- <li> **1** : 签署完成后通知对方来查看合同</li></ul>
24428
+ r"""<p>若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:</p><ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li><li> **1** : 签署完成后通知对方来查看合同</li></ul>
24624
24429
  :rtype: int
24625
24430
  """
24626
24431
  return self._CcNotifyType
@@ -24631,9 +24436,7 @@ class FlowInfo(AbstractModel):
24631
24436
 
24632
24437
  @property
24633
24438
  def AutoSignScene(self):
24634
- r"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
24635
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
24636
- 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
24439
+ r"""<p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
24637
24440
  :rtype: str
24638
24441
  """
24639
24442
  return self._AutoSignScene
@@ -24644,7 +24447,7 @@ class FlowInfo(AbstractModel):
24644
24447
 
24645
24448
  @property
24646
24449
  def FlowDisplayType(self):
24647
- r"""在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
24450
+ r"""<p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
24648
24451
  :rtype: int
24649
24452
  """
24650
24453
  return self._FlowDisplayType
@@ -24653,6 +24456,17 @@ class FlowInfo(AbstractModel):
24653
24456
  def FlowDisplayType(self, FlowDisplayType):
24654
24457
  self._FlowDisplayType = FlowDisplayType
24655
24458
 
24459
+ @property
24460
+ def FlowOperateLimit(self):
24461
+ r"""<p>发起合同流程时对合同流程的部分操作加以限制的配置。</p><p> 注:此参数目前<strong>只支持 CreateFlowsByTemplates接口</strong> 。</p>
24462
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowOperateLimit`
24463
+ """
24464
+ return self._FlowOperateLimit
24465
+
24466
+ @FlowOperateLimit.setter
24467
+ def FlowOperateLimit(self, FlowOperateLimit):
24468
+ self._FlowOperateLimit = FlowOperateLimit
24469
+
24656
24470
 
24657
24471
  def _deserialize(self, params):
24658
24472
  self._FlowName = params.get("FlowName")
@@ -24685,6 +24499,45 @@ class FlowInfo(AbstractModel):
24685
24499
  self._CcNotifyType = params.get("CcNotifyType")
24686
24500
  self._AutoSignScene = params.get("AutoSignScene")
24687
24501
  self._FlowDisplayType = params.get("FlowDisplayType")
24502
+ if params.get("FlowOperateLimit") is not None:
24503
+ self._FlowOperateLimit = FlowOperateLimit()
24504
+ self._FlowOperateLimit._deserialize(params.get("FlowOperateLimit"))
24505
+ memeber_set = set(params.keys())
24506
+ for name, value in vars(self).items():
24507
+ property_name = name[1:]
24508
+ if property_name in memeber_set:
24509
+ memeber_set.remove(property_name)
24510
+ if len(memeber_set) > 0:
24511
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
24512
+
24513
+
24514
+
24515
+ class FlowOperateLimit(AbstractModel):
24516
+ r"""发起合同流程时对合同流程的部分操作加以限制的配置。
24517
+
24518
+ """
24519
+
24520
+ def __init__(self):
24521
+ r"""
24522
+ :param _NoRelease: <p>发起合同流程时,对签署完成后是否能发起对应的解除合同加以限制:<ul><li><b>false(默认值)</b>: 合同流程完成签署后,支持发起对应的解除协议。</li><li><b>true </b>: 合同流程完成签署后,<b>不支持</b>发起对应的解除协议。</li></ul></p>
24523
+ :type NoRelease: bool
24524
+ """
24525
+ self._NoRelease = None
24526
+
24527
+ @property
24528
+ def NoRelease(self):
24529
+ r"""<p>发起合同流程时,对签署完成后是否能发起对应的解除合同加以限制:<ul><li><b>false(默认值)</b>: 合同流程完成签署后,支持发起对应的解除协议。</li><li><b>true </b>: 合同流程完成签署后,<b>不支持</b>发起对应的解除协议。</li></ul></p>
24530
+ :rtype: bool
24531
+ """
24532
+ return self._NoRelease
24533
+
24534
+ @NoRelease.setter
24535
+ def NoRelease(self, NoRelease):
24536
+ self._NoRelease = NoRelease
24537
+
24538
+
24539
+ def _deserialize(self, params):
24540
+ self._NoRelease = params.get("NoRelease")
24688
24541
  memeber_set = set(params.keys())
24689
24542
  for name, value in vars(self).items():
24690
24543
  property_name = name[1:]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.1.51
3
+ Version: 3.1.59
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common <4.0.0,>=3.1.51
18
+ Requires-Dist: tencentcloud-sdk-python-common <4.0.0,>=3.1.59
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -1,4 +1,4 @@
1
- tencentcloud/__init__.py,sha256=PMVHB2WKg5lme-kDJUySgKWvLoAdss1lO3KMUCUWRN0,629
1
+ tencentcloud/__init__.py,sha256=GVKa6_cNf9AZ1e3y8dYgDfWF9LE1xZJtLNMz5mJnfEk,629
2
2
  tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
3
  tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
4
  tencentcloud/essbasic/v20201222/errorcodes.py,sha256=_HaXGynY1ocz-dbY7C6IOlNUWmNMu9XsY-x11g3Rm-w,5365
@@ -9,8 +9,8 @@ tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
9
9
  tencentcloud/essbasic/v20210526/errorcodes.py,sha256=4Cs5syJZPMDlJQ8jT1hxH-gj5BrvgIKo7VBrrcRDvsk,19287
10
10
  tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=mHJPsv67i9uSTX9a3Jj51imMkkXj6ZwLHMSM9HG__qw,176085
11
11
  tencentcloud/essbasic/v20210526/essbasic_client_async.py,sha256=cmw5Q8LtnUXTFoVCDpJcHjTbevWwaI78pM7RSBR2_1s,146074
12
- tencentcloud/essbasic/v20210526/models.py,sha256=QTxj-YAKGQEtRNpaguJE99TeyjhmLuOfdlsLhzyOh-I,1368077
13
- tencentcloud_sdk_python_essbasic-3.1.51.dist-info/METADATA,sha256=NHM6sRFizQJHusTV9s4TCHmWzwXm5hmvroGgwjy1VnE,1520
14
- tencentcloud_sdk_python_essbasic-3.1.51.dist-info/WHEEL,sha256=a5ogxI61vGGBHYbAAwISCXsfU7mxKr76gTpCEmSNOI8,109
15
- tencentcloud_sdk_python_essbasic-3.1.51.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
16
- tencentcloud_sdk_python_essbasic-3.1.51.dist-info/RECORD,,
12
+ tencentcloud/essbasic/v20210526/models.py,sha256=2ZqA-t9MNw-YBsZenCYe0SB6TuJ-Ct2AycMvftSQsJo,1374699
13
+ tencentcloud_sdk_python_essbasic-3.1.59.dist-info/METADATA,sha256=ujSG7YzKpDDQAMSsxGhbFDGg4qq22IkAa2I_OArg6bY,1520
14
+ tencentcloud_sdk_python_essbasic-3.1.59.dist-info/WHEEL,sha256=a5ogxI61vGGBHYbAAwISCXsfU7mxKr76gTpCEmSNOI8,109
15
+ tencentcloud_sdk_python_essbasic-3.1.59.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
16
+ tencentcloud_sdk_python_essbasic-3.1.59.dist-info/RECORD,,