tencentcloud-sdk-python-ess 3.1.89__tar.gz → 3.1.97__tar.gz

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.
Files changed (17) hide show
  1. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/setup.py +1 -1
  3. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud/ess/v20201111/models.py +153 -190
  5. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
  6. tencentcloud_sdk_python_ess-3.1.97/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
  7. tencentcloud_sdk_python_ess-3.1.89/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
  8. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/README.rst +0 -0
  9. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/setup.cfg +0 -0
  10. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud/ess/__init__.py +0 -0
  11. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud/ess/v20201111/__init__.py +0 -0
  12. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
  13. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud/ess/v20201111/ess_client.py +0 -0
  14. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud/ess/v20201111/ess_client_async.py +0 -0
  15. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_ess-3.1.89 → tencentcloud_sdk_python_ess-3.1.97}/tencentcloud_sdk_python_ess.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.89
3
+ Version: 3.1.97
4
4
  Summary: Tencent Cloud Ess 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.89
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.97
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-ess',
11
- install_requires=["tencentcloud-sdk-python-common>=3.1.89,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.97,<4.0.0"],
12
12
 
13
13
  version=tencentcloud.__version__,
14
14
  description='Tencent Cloud Ess SDK for Python',
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.89'
17
+ __version__ = '3.1.97'
@@ -15155,52 +15155,39 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15155
15155
 
15156
15156
  def __init__(self):
15157
15157
  r"""
15158
- :param _Operator: 执行本接口操作的员工信息。
15159
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
15158
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
15160
15159
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
15161
- :param _TemplateId: 合同模板ID,为32位字符串。
15162
- 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
15160
+ :param _TemplateId: <p>合同模板ID,为32位字符串。<br>可登录腾讯电子签控制台,在 &quot;模板&quot;-&gt;&quot;模板中心&quot;-&gt;&quot;列表展示设置&quot;选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。</p>
15163
15161
  :type TemplateId: str
15164
- :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
15165
- 该名称还将用于合同签署完成后的下载文件名。
15162
+ :param _FlowName: <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。<br>该名称还将用于合同签署完成后的下载文件名。</p>
15166
15163
  :type FlowName: str
15167
- :param _MaxFlowNum: 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
15168
- 一旦发起流程数超越该限制,该二维码将自动失效。
15164
+ :param _MaxFlowNum: <p>通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。<br>一旦发起流程数超越该限制,该二维码将自动失效。</p>
15169
15165
  :type MaxFlowNum: int
15170
- :param _QrEffectiveDay: 二维码的有效期限,默认为7天,最高设定不得超过90天。
15171
- 一旦超过二维码的有效期限,该二维码将自动失效。
15166
+ :param _QrEffectiveDay: <p>二维码的有效期限,默认为7天,最高设定不得超过90天。<br>一旦超过二维码的有效期限,该二维码将自动失效。</p>
15172
15167
  :type QrEffectiveDay: int
15173
- :param _FlowEffectiveDay: 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
15174
- 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
15175
- 最长设定期限不得超过30天。
15168
+ :param _FlowEffectiveDay: <p>合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。<br>若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。<br>最长设定期限不得超过30天。</p>
15176
15169
  :type FlowEffectiveDay: int
15177
- :param _Restrictions: 指定签署人信息。
15178
- 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
15170
+ :param _FlowDisplayType: <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:<br> <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p><p>枚举值:</p><ul><li>0: 合同</li><li>1: 文件</li><li>2: 协议</li><li>3: 文书</li></ul><p>默认值:0</p>
15171
+ :type FlowDisplayType: int
15172
+ :param _Restrictions: <p>指定签署人信息。<br>在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。</p>
15179
15173
  :type Restrictions: list of ApproverRestriction
15180
- :param _UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
15181
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
15182
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
15174
+ :param _UserData: <p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。<br>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
15183
15175
  :type UserData: str
15184
- :param _CallbackUrl: 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
15185
- <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
15186
- <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
15187
-
15176
+ :param _CallbackUrl: <p>已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置<br><br> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign<br><br> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83</p>
15188
15177
  :type CallbackUrl: str
15189
- :param _Agent: 代理企业和员工的信息。
15190
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
15178
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
15191
15179
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
15192
- :param _ApproverRestrictions: 限制二维码用户条件(已弃用)
15180
+ :param _ApproverRestrictions: <p>限制二维码用户条件(已弃用)</p>
15193
15181
  :type ApproverRestrictions: :class:`tencentcloud.ess.v20201111.models.ApproverRestriction`
15194
- :param _ApproverComponentLimitTypes: 指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。
15182
+ :param _ApproverComponentLimitTypes: <p>指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。</p>
15195
15183
  :type ApproverComponentLimitTypes: list of ApproverComponentLimitType
15196
- :param _ForbidPersonalMultipleSign: 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true
15184
+ :param _ForbidPersonalMultipleSign: <p>禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。</p>
15197
15185
  :type ForbidPersonalMultipleSign: bool
15198
- :param _FlowNameAppendScannerInfo: 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。
15199
- 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
15186
+ :param _FlowNameAppendScannerInfo: <p>合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。<br>例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。</p>
15200
15187
  :type FlowNameAppendScannerInfo: bool
15201
- :param _QrCodeName: 签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName
15188
+ :param _QrCodeName: <p>签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName</p>
15202
15189
  :type QrCodeName: str
15203
- :param _QrCodeExpiredOn: 签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。
15190
+ :param _QrCodeExpiredOn: <p>签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。</p>
15204
15191
  :type QrCodeExpiredOn: int
15205
15192
  """
15206
15193
  self._Operator = None
@@ -15209,6 +15196,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15209
15196
  self._MaxFlowNum = None
15210
15197
  self._QrEffectiveDay = None
15211
15198
  self._FlowEffectiveDay = None
15199
+ self._FlowDisplayType = None
15212
15200
  self._Restrictions = None
15213
15201
  self._UserData = None
15214
15202
  self._CallbackUrl = None
@@ -15222,8 +15210,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15222
15210
 
15223
15211
  @property
15224
15212
  def Operator(self):
15225
- r"""执行本接口操作的员工信息。
15226
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
15213
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
15227
15214
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
15228
15215
  """
15229
15216
  return self._Operator
@@ -15234,8 +15221,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15234
15221
 
15235
15222
  @property
15236
15223
  def TemplateId(self):
15237
- r"""合同模板ID,为32位字符串。
15238
- 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
15224
+ r"""<p>合同模板ID,为32位字符串。<br>可登录腾讯电子签控制台,在 &quot;模板&quot;-&gt;&quot;模板中心&quot;-&gt;&quot;列表展示设置&quot;选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。</p>
15239
15225
  :rtype: str
15240
15226
  """
15241
15227
  return self._TemplateId
@@ -15246,8 +15232,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15246
15232
 
15247
15233
  @property
15248
15234
  def FlowName(self):
15249
- r"""合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
15250
- 该名称还将用于合同签署完成后的下载文件名。
15235
+ r"""<p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。<br>该名称还将用于合同签署完成后的下载文件名。</p>
15251
15236
  :rtype: str
15252
15237
  """
15253
15238
  return self._FlowName
@@ -15258,8 +15243,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15258
15243
 
15259
15244
  @property
15260
15245
  def MaxFlowNum(self):
15261
- r"""通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
15262
- 一旦发起流程数超越该限制,该二维码将自动失效。
15246
+ r"""<p>通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。<br>一旦发起流程数超越该限制,该二维码将自动失效。</p>
15263
15247
  :rtype: int
15264
15248
  """
15265
15249
  return self._MaxFlowNum
@@ -15272,8 +15256,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15272
15256
  def QrEffectiveDay(self):
15273
15257
  warnings.warn("parameter `QrEffectiveDay` is deprecated", DeprecationWarning)
15274
15258
 
15275
- r"""二维码的有效期限,默认为7天,最高设定不得超过90天。
15276
- 一旦超过二维码的有效期限,该二维码将自动失效。
15259
+ r"""<p>二维码的有效期限,默认为7天,最高设定不得超过90天。<br>一旦超过二维码的有效期限,该二维码将自动失效。</p>
15277
15260
  :rtype: int
15278
15261
  """
15279
15262
  return self._QrEffectiveDay
@@ -15286,9 +15269,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15286
15269
 
15287
15270
  @property
15288
15271
  def FlowEffectiveDay(self):
15289
- r"""合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
15290
- 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
15291
- 最长设定期限不得超过30天。
15272
+ r"""<p>合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。<br>若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。<br>最长设定期限不得超过30天。</p>
15292
15273
  :rtype: int
15293
15274
  """
15294
15275
  return self._FlowEffectiveDay
@@ -15297,10 +15278,20 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15297
15278
  def FlowEffectiveDay(self, FlowEffectiveDay):
15298
15279
  self._FlowEffectiveDay = FlowEffectiveDay
15299
15280
 
15281
+ @property
15282
+ def FlowDisplayType(self):
15283
+ r"""<p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:<br> <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul></p><p>效果如下:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p><p>枚举值:</p><ul><li>0: 合同</li><li>1: 文件</li><li>2: 协议</li><li>3: 文书</li></ul><p>默认值:0</p>
15284
+ :rtype: int
15285
+ """
15286
+ return self._FlowDisplayType
15287
+
15288
+ @FlowDisplayType.setter
15289
+ def FlowDisplayType(self, FlowDisplayType):
15290
+ self._FlowDisplayType = FlowDisplayType
15291
+
15300
15292
  @property
15301
15293
  def Restrictions(self):
15302
- r"""指定签署人信息。
15303
- 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
15294
+ r"""<p>指定签署人信息。<br>在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。</p>
15304
15295
  :rtype: list of ApproverRestriction
15305
15296
  """
15306
15297
  return self._Restrictions
@@ -15311,9 +15302,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15311
15302
 
15312
15303
  @property
15313
15304
  def UserData(self):
15314
- r"""调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
15315
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
15316
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
15305
+ r"""<p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。<br>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
15317
15306
  :rtype: str
15318
15307
  """
15319
15308
  return self._UserData
@@ -15326,10 +15315,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15326
15315
  def CallbackUrl(self):
15327
15316
  warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
15328
15317
 
15329
- r"""已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
15330
- <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
15331
- <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
15332
-
15318
+ r"""<p>已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置<br><br> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign<br><br> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83</p>
15333
15319
  :rtype: str
15334
15320
  """
15335
15321
  return self._CallbackUrl
@@ -15342,8 +15328,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15342
15328
 
15343
15329
  @property
15344
15330
  def Agent(self):
15345
- r"""代理企业和员工的信息。
15346
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
15331
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
15347
15332
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
15348
15333
  """
15349
15334
  return self._Agent
@@ -15356,7 +15341,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15356
15341
  def ApproverRestrictions(self):
15357
15342
  warnings.warn("parameter `ApproverRestrictions` is deprecated", DeprecationWarning)
15358
15343
 
15359
- r"""限制二维码用户条件(已弃用)
15344
+ r"""<p>限制二维码用户条件(已弃用)</p>
15360
15345
  :rtype: :class:`tencentcloud.ess.v20201111.models.ApproverRestriction`
15361
15346
  """
15362
15347
  return self._ApproverRestrictions
@@ -15369,7 +15354,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15369
15354
 
15370
15355
  @property
15371
15356
  def ApproverComponentLimitTypes(self):
15372
- r"""指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。
15357
+ r"""<p>指定签署方在使用个人印章签署控件(SIGN_SIGNATURE) 时可使用的签署方式:自由书写、正楷临摹、系统签名、个人印章。</p>
15373
15358
  :rtype: list of ApproverComponentLimitType
15374
15359
  """
15375
15360
  return self._ApproverComponentLimitTypes
@@ -15380,7 +15365,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15380
15365
 
15381
15366
  @property
15382
15367
  def ForbidPersonalMultipleSign(self):
15383
- r"""禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true
15368
+ r"""<p>禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。</p>
15384
15369
  :rtype: bool
15385
15370
  """
15386
15371
  return self._ForbidPersonalMultipleSign
@@ -15391,8 +15376,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15391
15376
 
15392
15377
  @property
15393
15378
  def FlowNameAppendScannerInfo(self):
15394
- r"""合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。
15395
- 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
15379
+ r"""<p>合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。<br>例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。</p>
15396
15380
  :rtype: bool
15397
15381
  """
15398
15382
  return self._FlowNameAppendScannerInfo
@@ -15403,7 +15387,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15403
15387
 
15404
15388
  @property
15405
15389
  def QrCodeName(self):
15406
- r"""签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName
15390
+ r"""<p>签署二维码的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成,会在生成的二维码图片上展示,若为空,则使用FlowName</p>
15407
15391
  :rtype: str
15408
15392
  """
15409
15393
  return self._QrCodeName
@@ -15414,7 +15398,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15414
15398
 
15415
15399
  @property
15416
15400
  def QrCodeExpiredOn(self):
15417
- r"""签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。
15401
+ r"""<p>签署二维码截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为签署二维码创建后的7天时截止,最长可设置为签署二维码创建后的365天时截止。</p>
15418
15402
  :rtype: int
15419
15403
  """
15420
15404
  return self._QrCodeExpiredOn
@@ -15433,6 +15417,7 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
15433
15417
  self._MaxFlowNum = params.get("MaxFlowNum")
15434
15418
  self._QrEffectiveDay = params.get("QrEffectiveDay")
15435
15419
  self._FlowEffectiveDay = params.get("FlowEffectiveDay")
15420
+ self._FlowDisplayType = params.get("FlowDisplayType")
15436
15421
  if params.get("Restrictions") is not None:
15437
15422
  self._Restrictions = []
15438
15423
  for item in params.get("Restrictions"):
@@ -15474,9 +15459,9 @@ class CreateMultiFlowSignQRCodeResponse(AbstractModel):
15474
15459
 
15475
15460
  def __init__(self):
15476
15461
  r"""
15477
- :param _QrCode: 一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。
15462
+ :param _QrCode: <p>一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。</p>
15478
15463
  :type QrCode: :class:`tencentcloud.ess.v20201111.models.SignQrCode`
15479
- :param _SignUrls: 一码多签签署码的链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
15464
+ :param _SignUrls: <p>一码多签签署码的链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。</p>
15480
15465
  :type SignUrls: :class:`tencentcloud.ess.v20201111.models.SignUrl`
15481
15466
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
15482
15467
  :type RequestId: str
@@ -15487,7 +15472,7 @@ class CreateMultiFlowSignQRCodeResponse(AbstractModel):
15487
15472
 
15488
15473
  @property
15489
15474
  def QrCode(self):
15490
- r"""一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。
15475
+ r"""<p>一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。</p>
15491
15476
  :rtype: :class:`tencentcloud.ess.v20201111.models.SignQrCode`
15492
15477
  """
15493
15478
  return self._QrCode
@@ -15498,7 +15483,7 @@ class CreateMultiFlowSignQRCodeResponse(AbstractModel):
15498
15483
 
15499
15484
  @property
15500
15485
  def SignUrls(self):
15501
- r"""一码多签签署码的链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
15486
+ r"""<p>一码多签签署码的链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。</p>
15502
15487
  :rtype: :class:`tencentcloud.ess.v20201111.models.SignUrl`
15503
15488
  """
15504
15489
  return self._SignUrls
@@ -19598,70 +19583,43 @@ class CreateSealRequest(AbstractModel):
19598
19583
 
19599
19584
  def __init__(self):
19600
19585
  r"""
19601
- :param _Operator: 执行本接口操作的员工信息。
19602
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
19586
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
19603
19587
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
19604
- :param _SealName: 电子印章名字,1-50个中文字符
19605
- 注:`同一企业下电子印章名字不能相同`
19588
+ :param _SealName: <p>电子印章名字,1-50个中文字符<br>注:<code>同一企业下电子印章名字不能相同</code></p>
19606
19589
  :type SealName: str
19607
- :param _Agent: 代理企业和员工的信息。
19608
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
19590
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
19609
19591
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
19610
- :param _GenerateSource: 电子印章生成方式
19611
- <ul>
19612
- <li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
19613
- <li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
19614
- </ul>
19592
+ :param _GenerateSource: <p>电子印章生成方式</p><ul><li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li><li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li></ul>
19615
19593
  :type GenerateSource: str
19616
- :param _SealType: 电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**OTHER**: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错
19594
+ :param _SealType: <p>电子印章类型 , 可选类型如下: <ul><li><strong>OFFICIAL</strong>: (默认)公章</li><li><strong>CONTRACT</strong>: 合同专用章;</li><li><strong>FINANCE</strong>: 财务专用章;</li><li><strong>PERSONNEL</strong>: 人事专用章</li><li><strong>INVOICE</strong>: 发票专用章</li><li><strong>OTHER</strong>: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错</p>
19617
19595
  :type SealType: str
19618
- :param _FileName: 电子印章图片文件名称,1-50个中文字符。
19596
+ :param _FileName: <p>电子印章图片文件名称,1-50个中文字符。</p>
19619
19597
  :type FileName: str
19620
- :param _Image: 电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式
19621
-
19622
- 注: `通过图片创建的电子印章,需电子签平台人工审核`
19623
-
19624
-
19598
+ :param _Image: <p>电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式</p><p>注: <code>通过图片创建的电子印章,需电子签平台人工审核</code></p>
19625
19599
  :type Image: str
19626
- :param _Width: 电子印章宽度,单位px
19627
- 参数不再启用,系统会设置印章大小为标准尺寸。
19600
+ :param _Width: <p>电子印章宽度,单位px<br>参数不再启用,系统会设置印章大小为标准尺寸。</p>
19628
19601
  :type Width: int
19629
- :param _Height: 电子印章高度,单位px
19630
- 参数不再启用,系统会设置印章大小为标准尺寸。
19602
+ :param _Height: <p>电子印章高度,单位px<br>参数不再启用,系统会设置印章大小为标准尺寸。</p>
19631
19603
  :type Height: int
19632
- :param _Color: 电子印章印章颜色(默认红色RED),RED-红色
19633
-
19634
- 系统目前只支持红色印章创建。
19604
+ :param _Color: <p>电子印章印章颜色(默认红色RED),RED-红色</p><p>系统目前只支持红色印章创建。</p>
19635
19605
  :type Color: str
19636
- :param _SealHorizontalText: 企业印章横向文字,最多可填15个汉字 (若超过印章最大宽度,优先压缩字间距,其次缩小字号)
19637
- 横向文字的位置如下图中的"印章横向文字在这里"
19638
-
19639
- ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png)
19640
-
19606
+ :param _SealHorizontalText: <p>企业印章横向文字,最多可填15个汉字 (若超过印章最大宽度,优先压缩字间距,其次缩小字号)<br>横向文字的位置如下图中的&quot;印章横向文字在这里&quot;</p><p><img src="https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png" alt="image"></p>
19641
19607
  :type SealHorizontalText: str
19642
- :param _SealChordText: 暂时不支持下弦文字设置
19608
+ :param _SealChordText: <p>暂时不支持下弦文字设置</p>
19643
19609
  :type SealChordText: str
19644
- :param _SealCentralType: 系统生成的印章只支持STAR
19610
+ :param _SealCentralType: <p>系统生成的印章只支持:STAR</p>
19645
19611
  :type SealCentralType: str
19646
- :param _FileToken: 通过文件上传时,服务端生成的电子印章上传图片的token
19647
-
19612
+ :param _FileToken: <p>通过文件上传时,服务端生成的电子印章上传图片的token</p>
19648
19613
  :type FileToken: str
19649
- :param _SealStyle: 印章样式, 可以选择的样式如下:
19650
- <ul><li>**circle**:(默认)圆形印章</li>
19651
- <li>**ellipse**:椭圆印章</li></ul>
19614
+ :param _SealStyle: <p>印章样式, 可以选择的样式如下: </p><ul><li>**circle**:(默认)圆形印章</li><li>**ellipse**:椭圆印章</li></ul>
19652
19615
  :type SealStyle: str
19653
- :param _SealSize: 印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> **42_42**(默认): 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **50_50**: 圆形企业印章直径50mm, 当SealStyle是圆形的时候才有效</li> <li> **58_58**: 圆形企业印章直径58mm, 当SealStyle是圆形的时候才有效</li> <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul>
19616
+ :param _SealSize: <p>印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> <strong>38_38</strong>: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>40_40</strong>: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>42_42</strong>(默认): 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>45_45</strong>: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>50_50</strong>: 圆形企业印章直径50mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>58_58</strong>: 圆形企业印章直径58mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>40_30</strong>: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> <strong>45_30</strong>: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul></p>
19654
19617
  :type SealSize: str
19655
- :param _TaxIdentifyCode: 企业税号
19656
- 注:
19657
- <ul>
19658
- <li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li>
19659
- <li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color="red">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li>
19660
- </ul>
19618
+ :param _TaxIdentifyCode: <p>企业税号<br>注:</p><ul><li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li><li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color="red">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li></ul>
19661
19619
  :type TaxIdentifyCode: str
19662
- :param _SealDescription: 印章描述内容
19620
+ :param _SealDescription: <p>印章描述内容</p>
19663
19621
  :type SealDescription: str
19664
- :param _Options: 个性化配置字段,默认不传。
19622
+ :param _Options: <p>个性化配置字段,默认不传。</p>
19665
19623
  :type Options: list of Option
19666
19624
  """
19667
19625
  self._Operator = None
@@ -19686,8 +19644,7 @@ class CreateSealRequest(AbstractModel):
19686
19644
 
19687
19645
  @property
19688
19646
  def Operator(self):
19689
- r"""执行本接口操作的员工信息。
19690
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
19647
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
19691
19648
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
19692
19649
  """
19693
19650
  return self._Operator
@@ -19698,8 +19655,7 @@ class CreateSealRequest(AbstractModel):
19698
19655
 
19699
19656
  @property
19700
19657
  def SealName(self):
19701
- r"""电子印章名字,1-50个中文字符
19702
- 注:`同一企业下电子印章名字不能相同`
19658
+ r"""<p>电子印章名字,1-50个中文字符<br>注:<code>同一企业下电子印章名字不能相同</code></p>
19703
19659
  :rtype: str
19704
19660
  """
19705
19661
  return self._SealName
@@ -19710,8 +19666,7 @@ class CreateSealRequest(AbstractModel):
19710
19666
 
19711
19667
  @property
19712
19668
  def Agent(self):
19713
- r"""代理企业和员工的信息。
19714
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
19669
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
19715
19670
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
19716
19671
  """
19717
19672
  return self._Agent
@@ -19722,11 +19677,7 @@ class CreateSealRequest(AbstractModel):
19722
19677
 
19723
19678
  @property
19724
19679
  def GenerateSource(self):
19725
- r"""电子印章生成方式
19726
- <ul>
19727
- <li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li>
19728
- <li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li>
19729
- </ul>
19680
+ r"""<p>电子印章生成方式</p><ul><li><strong>空值</strong>:(默认)使用上传的图片生成印章, 此时需要上传SealImage图片</li><li><strong>SealGenerateSourceSystem</strong>: 系统生成印章, 无需上传SealImage图片</li></ul>
19730
19681
  :rtype: str
19731
19682
  """
19732
19683
  return self._GenerateSource
@@ -19737,7 +19688,7 @@ class CreateSealRequest(AbstractModel):
19737
19688
 
19738
19689
  @property
19739
19690
  def SealType(self):
19740
- r"""电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: (默认)公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><li>**OTHER**: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错
19691
+ r"""<p>电子印章类型 , 可选类型如下: <ul><li><strong>OFFICIAL</strong>: (默认)公章</li><li><strong>CONTRACT</strong>: 合同专用章;</li><li><strong>FINANCE</strong>: 财务专用章;</li><li><strong>PERSONNEL</strong>: 人事专用章</li><li><strong>INVOICE</strong>: 发票专用章</li><li><strong>OTHER</strong>: 其他</li></ul>注: 同企业下只能有<font color="red">一个</font>公章, 重复创建会报错</p>
19741
19692
  :rtype: str
19742
19693
  """
19743
19694
  return self._SealType
@@ -19748,7 +19699,7 @@ class CreateSealRequest(AbstractModel):
19748
19699
 
19749
19700
  @property
19750
19701
  def FileName(self):
19751
- r"""电子印章图片文件名称,1-50个中文字符。
19702
+ r"""<p>电子印章图片文件名称,1-50个中文字符。</p>
19752
19703
  :rtype: str
19753
19704
  """
19754
19705
  return self._FileName
@@ -19759,11 +19710,7 @@ class CreateSealRequest(AbstractModel):
19759
19710
 
19760
19711
  @property
19761
19712
  def Image(self):
19762
- r"""电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式
19763
-
19764
- 注: `通过图片创建的电子印章,需电子签平台人工审核`
19765
-
19766
-
19713
+ r"""<p>电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式</p><p>注: <code>通过图片创建的电子印章,需电子签平台人工审核</code></p>
19767
19714
  :rtype: str
19768
19715
  """
19769
19716
  return self._Image
@@ -19774,8 +19721,7 @@ class CreateSealRequest(AbstractModel):
19774
19721
 
19775
19722
  @property
19776
19723
  def Width(self):
19777
- r"""电子印章宽度,单位px
19778
- 参数不再启用,系统会设置印章大小为标准尺寸。
19724
+ r"""<p>电子印章宽度,单位px<br>参数不再启用,系统会设置印章大小为标准尺寸。</p>
19779
19725
  :rtype: int
19780
19726
  """
19781
19727
  return self._Width
@@ -19786,8 +19732,7 @@ class CreateSealRequest(AbstractModel):
19786
19732
 
19787
19733
  @property
19788
19734
  def Height(self):
19789
- r"""电子印章高度,单位px
19790
- 参数不再启用,系统会设置印章大小为标准尺寸。
19735
+ r"""<p>电子印章高度,单位px<br>参数不再启用,系统会设置印章大小为标准尺寸。</p>
19791
19736
  :rtype: int
19792
19737
  """
19793
19738
  return self._Height
@@ -19798,9 +19743,7 @@ class CreateSealRequest(AbstractModel):
19798
19743
 
19799
19744
  @property
19800
19745
  def Color(self):
19801
- r"""电子印章印章颜色(默认红色RED),RED-红色
19802
-
19803
- 系统目前只支持红色印章创建。
19746
+ r"""<p>电子印章印章颜色(默认红色RED),RED-红色</p><p>系统目前只支持红色印章创建。</p>
19804
19747
  :rtype: str
19805
19748
  """
19806
19749
  return self._Color
@@ -19811,11 +19754,7 @@ class CreateSealRequest(AbstractModel):
19811
19754
 
19812
19755
  @property
19813
19756
  def SealHorizontalText(self):
19814
- r"""企业印章横向文字,最多可填15个汉字 (若超过印章最大宽度,优先压缩字间距,其次缩小字号)
19815
- 横向文字的位置如下图中的"印章横向文字在这里"
19816
-
19817
- ![image](https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png)
19818
-
19757
+ r"""<p>企业印章横向文字,最多可填15个汉字 (若超过印章最大宽度,优先压缩字间距,其次缩小字号)<br>横向文字的位置如下图中的&quot;印章横向文字在这里&quot;</p><p><img src="https://dyn.ess.tencent.cn/guide/capi/CreateSealByImage2.png" alt="image"></p>
19819
19758
  :rtype: str
19820
19759
  """
19821
19760
  return self._SealHorizontalText
@@ -19826,7 +19765,7 @@ class CreateSealRequest(AbstractModel):
19826
19765
 
19827
19766
  @property
19828
19767
  def SealChordText(self):
19829
- r"""暂时不支持下弦文字设置
19768
+ r"""<p>暂时不支持下弦文字设置</p>
19830
19769
  :rtype: str
19831
19770
  """
19832
19771
  return self._SealChordText
@@ -19837,7 +19776,7 @@ class CreateSealRequest(AbstractModel):
19837
19776
 
19838
19777
  @property
19839
19778
  def SealCentralType(self):
19840
- r"""系统生成的印章只支持STAR
19779
+ r"""<p>系统生成的印章只支持:STAR</p>
19841
19780
  :rtype: str
19842
19781
  """
19843
19782
  return self._SealCentralType
@@ -19848,8 +19787,7 @@ class CreateSealRequest(AbstractModel):
19848
19787
 
19849
19788
  @property
19850
19789
  def FileToken(self):
19851
- r"""通过文件上传时,服务端生成的电子印章上传图片的token
19852
-
19790
+ r"""<p>通过文件上传时,服务端生成的电子印章上传图片的token</p>
19853
19791
  :rtype: str
19854
19792
  """
19855
19793
  return self._FileToken
@@ -19860,9 +19798,7 @@ class CreateSealRequest(AbstractModel):
19860
19798
 
19861
19799
  @property
19862
19800
  def SealStyle(self):
19863
- r"""印章样式, 可以选择的样式如下:
19864
- <ul><li>**circle**:(默认)圆形印章</li>
19865
- <li>**ellipse**:椭圆印章</li></ul>
19801
+ r"""<p>印章样式, 可以选择的样式如下: </p><ul><li>**circle**:(默认)圆形印章</li><li>**ellipse**:椭圆印章</li></ul>
19866
19802
  :rtype: str
19867
19803
  """
19868
19804
  return self._SealStyle
@@ -19873,7 +19809,7 @@ class CreateSealRequest(AbstractModel):
19873
19809
 
19874
19810
  @property
19875
19811
  def SealSize(self):
19876
- r"""印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> **38_38**: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> **40_40**: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> **42_42**(默认): 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> **45_45**: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> **50_50**: 圆形企业印章直径50mm, 当SealStyle是圆形的时候才有效</li> <li> **58_58**: 圆形企业印章直径58mm, 当SealStyle是圆形的时候才有效</li> <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul>
19812
+ r"""<p>印章尺寸取值描述, 可以选择的尺寸如下: <ul><li> <strong>38_38</strong>: 圆形企业公章直径38mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>40_40</strong>: 圆形企业公章直径40mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>42_42</strong>(默认): 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>45_45</strong>: 圆形企业印章直径45mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>50_50</strong>: 圆形企业印章直径50mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>58_58</strong>: 圆形企业印章直径58mm, 当SealStyle是圆形的时候才有效</li> <li> <strong>40_30</strong>: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li> <li> <strong>45_30</strong>: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li> </ul></p>
19877
19813
  :rtype: str
19878
19814
  """
19879
19815
  return self._SealSize
@@ -19884,12 +19820,7 @@ class CreateSealRequest(AbstractModel):
19884
19820
 
19885
19821
  @property
19886
19822
  def TaxIdentifyCode(self):
19887
- r"""企业税号
19888
- 注:
19889
- <ul>
19890
- <li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li>
19891
- <li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color="red">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li>
19892
- </ul>
19823
+ r"""<p>企业税号<br>注:</p><ul><li>1.印章类型SealType是INVOICE类型时,此参数才会生效</li><li>2.印章类型SealType是INVOICE类型,且该字段没有传入值或传入空时,会取该企业对应的统一社会信用代码作为默认的企业税号(<font color="red">如果是通过授权书授权方式认证的企业,此参数必传不能为空</font>)</li></ul>
19893
19824
  :rtype: str
19894
19825
  """
19895
19826
  return self._TaxIdentifyCode
@@ -19900,7 +19831,7 @@ class CreateSealRequest(AbstractModel):
19900
19831
 
19901
19832
  @property
19902
19833
  def SealDescription(self):
19903
- r"""印章描述内容
19834
+ r"""<p>印章描述内容</p>
19904
19835
  :rtype: str
19905
19836
  """
19906
19837
  return self._SealDescription
@@ -19911,7 +19842,7 @@ class CreateSealRequest(AbstractModel):
19911
19842
 
19912
19843
  @property
19913
19844
  def Options(self):
19914
- r"""个性化配置字段,默认不传。
19845
+ r"""<p>个性化配置字段,默认不传。</p>
19915
19846
  :rtype: list of Option
19916
19847
  """
19917
19848
  return self._Options
@@ -19967,27 +19898,29 @@ class CreateSealResponse(AbstractModel):
19967
19898
 
19968
19899
  def __init__(self):
19969
19900
  r"""
19970
- :param _SealId: 电子印章ID,为32位字符串。
19971
- 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
19972
- 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
19901
+ :param _SealId: <p>电子印章ID,为32位字符串。<br>建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。<br>可登录腾讯电子签控制台,在 &quot;印章&quot;-&gt;&quot;印章中心&quot;选择查看的印章,在&quot;印章详情&quot; 中查看某个印章的SealId(在页面中展示为印章ID)。</p>
19973
19902
  :type SealId: str
19974
- :param _SealOperatorVerifyPath: 人脸验证操作人链接,用法可以参考"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)",默认为空。
19903
+ :param _SealOperatorVerifyPath: <p>人脸验证操作人链接,用法可以参考&quot;<a href="https://qian.tencent.com/developers/company/openwxminiprogram/">跳转电子签小程序配置</a>&quot;,默认为空。</p>
19975
19904
  :type SealOperatorVerifyPath: str
19976
- :param _SealOperatorVerifyQrcodeUrl: 人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。
19905
+ :param _SealOperatorVerifyQrcodeUrl: <p>人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。</p>
19977
19906
  :type SealOperatorVerifyQrcodeUrl: str
19907
+ :param _PreviewFileUrl: <p>创建印章预览逻辑,返回的是印章加盖在示例文件上的效果图片链接。</p>
19908
+ :type PreviewFileUrl: str
19909
+ :param _PreviewPdfUrl: <p>创建印章预览逻辑,返回的是印章加盖在示例文件上的效果PDF文件链接。</p>
19910
+ :type PreviewPdfUrl: str
19978
19911
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
19979
19912
  :type RequestId: str
19980
19913
  """
19981
19914
  self._SealId = None
19982
19915
  self._SealOperatorVerifyPath = None
19983
19916
  self._SealOperatorVerifyQrcodeUrl = None
19917
+ self._PreviewFileUrl = None
19918
+ self._PreviewPdfUrl = None
19984
19919
  self._RequestId = None
19985
19920
 
19986
19921
  @property
19987
19922
  def SealId(self):
19988
- r"""电子印章ID,为32位字符串。
19989
- 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
19990
- 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
19923
+ r"""<p>电子印章ID,为32位字符串。<br>建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。<br>可登录腾讯电子签控制台,在 &quot;印章&quot;-&gt;&quot;印章中心&quot;选择查看的印章,在&quot;印章详情&quot; 中查看某个印章的SealId(在页面中展示为印章ID)。</p>
19991
19924
  :rtype: str
19992
19925
  """
19993
19926
  return self._SealId
@@ -19998,7 +19931,7 @@ class CreateSealResponse(AbstractModel):
19998
19931
 
19999
19932
  @property
20000
19933
  def SealOperatorVerifyPath(self):
20001
- r"""人脸验证操作人链接,用法可以参考"[跳转电子签小程序配置](https://qian.tencent.com/developers/company/openwxminiprogram/)",默认为空。
19934
+ r"""<p>人脸验证操作人链接,用法可以参考&quot;<a href="https://qian.tencent.com/developers/company/openwxminiprogram/">跳转电子签小程序配置</a>&quot;,默认为空。</p>
20002
19935
  :rtype: str
20003
19936
  """
20004
19937
  return self._SealOperatorVerifyPath
@@ -20009,7 +19942,7 @@ class CreateSealResponse(AbstractModel):
20009
19942
 
20010
19943
  @property
20011
19944
  def SealOperatorVerifyQrcodeUrl(self):
20012
- r"""人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。
19945
+ r"""<p>人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。</p>
20013
19946
  :rtype: str
20014
19947
  """
20015
19948
  return self._SealOperatorVerifyQrcodeUrl
@@ -20018,6 +19951,28 @@ class CreateSealResponse(AbstractModel):
20018
19951
  def SealOperatorVerifyQrcodeUrl(self, SealOperatorVerifyQrcodeUrl):
20019
19952
  self._SealOperatorVerifyQrcodeUrl = SealOperatorVerifyQrcodeUrl
20020
19953
 
19954
+ @property
19955
+ def PreviewFileUrl(self):
19956
+ r"""<p>创建印章预览逻辑,返回的是印章加盖在示例文件上的效果图片链接。</p>
19957
+ :rtype: str
19958
+ """
19959
+ return self._PreviewFileUrl
19960
+
19961
+ @PreviewFileUrl.setter
19962
+ def PreviewFileUrl(self, PreviewFileUrl):
19963
+ self._PreviewFileUrl = PreviewFileUrl
19964
+
19965
+ @property
19966
+ def PreviewPdfUrl(self):
19967
+ r"""<p>创建印章预览逻辑,返回的是印章加盖在示例文件上的效果PDF文件链接。</p>
19968
+ :rtype: str
19969
+ """
19970
+ return self._PreviewPdfUrl
19971
+
19972
+ @PreviewPdfUrl.setter
19973
+ def PreviewPdfUrl(self, PreviewPdfUrl):
19974
+ self._PreviewPdfUrl = PreviewPdfUrl
19975
+
20021
19976
  @property
20022
19977
  def RequestId(self):
20023
19978
  r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -20034,6 +19989,8 @@ class CreateSealResponse(AbstractModel):
20034
19989
  self._SealId = params.get("SealId")
20035
19990
  self._SealOperatorVerifyPath = params.get("SealOperatorVerifyPath")
20036
19991
  self._SealOperatorVerifyQrcodeUrl = params.get("SealOperatorVerifyQrcodeUrl")
19992
+ self._PreviewFileUrl = params.get("PreviewFileUrl")
19993
+ self._PreviewPdfUrl = params.get("PreviewPdfUrl")
20037
19994
  self._RequestId = params.get("RequestId")
20038
19995
 
20039
19996
 
@@ -42107,30 +42064,26 @@ class RecipientComponentInfo(AbstractModel):
42107
42064
 
42108
42065
  def __init__(self):
42109
42066
  r"""
42110
- :param _RecipientId: 签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方
42067
+ :param _RecipientId: <p>签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方</p>
42111
42068
  :type RecipientId: str
42112
- :param _RecipientFillStatus: 参与方填写状态
42113
- <ul>
42114
- <li>**空值** : 此参与方没有填写控件</li>
42115
- <li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li>
42116
- <li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
42117
-
42069
+ :param _RecipientFillStatus: <p>参与方填写状态</p><ul><li>**空值** : 此参与方没有填写控件</li><li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li><li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
42118
42070
  :type RecipientFillStatus: str
42119
- :param _IsPromoter: 是否为发起方
42120
- <ul><li>true-发起方</li>
42121
- <li>false-参与方</li></ul>
42071
+ :param _IsPromoter: <p>是否为发起方</p><ul><li>true-发起方</li><li>false-参与方</li></ul>
42122
42072
  :type IsPromoter: bool
42123
- :param _Components: 改参与方填写控件信息列表
42073
+ :param _Components: <p>该参与方填写控件信息列表</p>
42124
42074
  :type Components: list of FilledComponent
42075
+ :param _SignComponents: <p>该参与方签批控件信息</p>
42076
+ :type SignComponents: list of FilledComponent
42125
42077
  """
42126
42078
  self._RecipientId = None
42127
42079
  self._RecipientFillStatus = None
42128
42080
  self._IsPromoter = None
42129
42081
  self._Components = None
42082
+ self._SignComponents = None
42130
42083
 
42131
42084
  @property
42132
42085
  def RecipientId(self):
42133
- r"""签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方
42086
+ r"""<p>签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方</p>
42134
42087
  :rtype: str
42135
42088
  """
42136
42089
  return self._RecipientId
@@ -42141,12 +42094,7 @@ class RecipientComponentInfo(AbstractModel):
42141
42094
 
42142
42095
  @property
42143
42096
  def RecipientFillStatus(self):
42144
- r"""参与方填写状态
42145
- <ul>
42146
- <li>**空值** : 此参与方没有填写控件</li>
42147
- <li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li>
42148
- <li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
42149
-
42097
+ r"""<p>参与方填写状态</p><ul><li>**空值** : 此参与方没有填写控件</li><li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li><li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
42150
42098
  :rtype: str
42151
42099
  """
42152
42100
  return self._RecipientFillStatus
@@ -42157,9 +42105,7 @@ class RecipientComponentInfo(AbstractModel):
42157
42105
 
42158
42106
  @property
42159
42107
  def IsPromoter(self):
42160
- r"""是否为发起方
42161
- <ul><li>true-发起方</li>
42162
- <li>false-参与方</li></ul>
42108
+ r"""<p>是否为发起方</p><ul><li>true-发起方</li><li>false-参与方</li></ul>
42163
42109
  :rtype: bool
42164
42110
  """
42165
42111
  return self._IsPromoter
@@ -42170,7 +42116,7 @@ class RecipientComponentInfo(AbstractModel):
42170
42116
 
42171
42117
  @property
42172
42118
  def Components(self):
42173
- r"""改参与方填写控件信息列表
42119
+ r"""<p>该参与方填写控件信息列表</p>
42174
42120
  :rtype: list of FilledComponent
42175
42121
  """
42176
42122
  return self._Components
@@ -42179,6 +42125,17 @@ class RecipientComponentInfo(AbstractModel):
42179
42125
  def Components(self, Components):
42180
42126
  self._Components = Components
42181
42127
 
42128
+ @property
42129
+ def SignComponents(self):
42130
+ r"""<p>该参与方签批控件信息</p>
42131
+ :rtype: list of FilledComponent
42132
+ """
42133
+ return self._SignComponents
42134
+
42135
+ @SignComponents.setter
42136
+ def SignComponents(self, SignComponents):
42137
+ self._SignComponents = SignComponents
42138
+
42182
42139
 
42183
42140
  def _deserialize(self, params):
42184
42141
  self._RecipientId = params.get("RecipientId")
@@ -42190,6 +42147,12 @@ class RecipientComponentInfo(AbstractModel):
42190
42147
  obj = FilledComponent()
42191
42148
  obj._deserialize(item)
42192
42149
  self._Components.append(obj)
42150
+ if params.get("SignComponents") is not None:
42151
+ self._SignComponents = []
42152
+ for item in params.get("SignComponents"):
42153
+ obj = FilledComponent()
42154
+ obj._deserialize(item)
42155
+ self._SignComponents.append(obj)
42193
42156
  memeber_set = set(params.keys())
42194
42157
  for name, value in vars(self).items():
42195
42158
  property_name = name[1:]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.89
3
+ Version: 3.1.97
4
4
  Summary: Tencent Cloud Ess 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.89
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.97
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.97
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.89