tencentcloud-sdk-python-ess 3.1.136__tar.gz → 3.1.140__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.136 → tencentcloud_sdk_python_ess-3.1.140}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/setup.py +1 -1
  3. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud/ess/v20201111/ess_client.py +1 -1
  5. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud/ess/v20201111/ess_client_async.py +1 -1
  6. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud/ess/v20201111/models.py +89 -168
  7. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
  8. tencentcloud_sdk_python_ess-3.1.140/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
  9. tencentcloud_sdk_python_ess-3.1.136/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
  10. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/README.rst +0 -0
  11. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/setup.cfg +0 -0
  12. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud/ess/__init__.py +0 -0
  13. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud/ess/v20201111/__init__.py +0 -0
  14. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
  15. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_ess-3.1.136 → tencentcloud_sdk_python_ess-3.1.140}/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.136
3
+ Version: 3.1.140
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.136
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.140
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.136,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.140,<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.136'
17
+ __version__ = '3.1.140'
@@ -2215,7 +2215,7 @@ class EssClient(AbstractClient):
2215
2215
  1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
2216
2216
  2. 已经在授权中或者授权成功的企业,无法重复授权
2217
2217
  3. 授权企业和被授权企业必须都是已认证企业
2218
- 4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。
2218
+ 4. <font color='red'>需要授权企业的超管或者法人打开链接</font>走开通逻辑。
2219
2219
 
2220
2220
 
2221
2221
  **该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**
@@ -1909,7 +1909,7 @@ class EssClient(AbstractClient):
1909
1909
  1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
1910
1910
  2. 已经在授权中或者授权成功的企业,无法重复授权
1911
1911
  3. 授权企业和被授权企业必须都是已认证企业
1912
- 4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。
1912
+ 4. <font color='red'>需要授权企业的超管或者法人打开链接</font>走开通逻辑。
1913
1913
 
1914
1914
 
1915
1915
  **该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**
@@ -10850,20 +10850,15 @@ class CreateFlowEvidenceReportRequest(AbstractModel):
10850
10850
 
10851
10851
  def __init__(self):
10852
10852
  r"""
10853
- :param _Operator: 执行本接口操作的员工信息。
10854
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10853
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10855
10854
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
10856
- :param _FlowId: 合同流程ID,为32位字符串。
10857
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
10855
+ :param _FlowId: <p>合同流程ID,为32位字符串。<br>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p>
10858
10856
  :type FlowId: str
10859
- :param _Agent: 代理企业和员工的信息。
10860
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10857
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10861
10858
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
10862
- :param _ReportType: 指定申请的报告类型,可选类型如下:
10863
- <ul><li> **0** :合同签署报告(默认)</li>
10864
- <li> **1** :公证处核验报告</li></ul>
10859
+ :param _ReportType: <p>指定申请的报告类型,可选类型如下:<ul><li> <strong>0</strong> :合同签署报告(默认)</li></ul></p><p>枚举值:</p><ul><li>0: 合同签署报告</li></ul>
10865
10860
  :type ReportType: int
10866
- :param _HybridEvidenceFlowFile: 混合云模式获取合同文件合并出证,默认:不同意。注:此参数需要联系腾讯电子签运营进行开通后生效
10861
+ :param _HybridEvidenceFlowFile: <p>混合云模式获取合同文件合并出证,默认:不同意。注:此参数需要联系腾讯电子签运营进行开通后生效</p>
10867
10862
  :type HybridEvidenceFlowFile: bool
10868
10863
  """
10869
10864
  self._Operator = None
@@ -10874,8 +10869,7 @@ class CreateFlowEvidenceReportRequest(AbstractModel):
10874
10869
 
10875
10870
  @property
10876
10871
  def Operator(self):
10877
- r"""执行本接口操作的员工信息。
10878
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10872
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10879
10873
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
10880
10874
  """
10881
10875
  return self._Operator
@@ -10886,8 +10880,7 @@ class CreateFlowEvidenceReportRequest(AbstractModel):
10886
10880
 
10887
10881
  @property
10888
10882
  def FlowId(self):
10889
- r"""合同流程ID,为32位字符串。
10890
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
10883
+ r"""<p>合同流程ID,为32位字符串。<br>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p>
10891
10884
  :rtype: str
10892
10885
  """
10893
10886
  return self._FlowId
@@ -10898,8 +10891,7 @@ class CreateFlowEvidenceReportRequest(AbstractModel):
10898
10891
 
10899
10892
  @property
10900
10893
  def Agent(self):
10901
- r"""代理企业和员工的信息。
10902
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
10894
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
10903
10895
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
10904
10896
  """
10905
10897
  return self._Agent
@@ -10910,9 +10902,7 @@ class CreateFlowEvidenceReportRequest(AbstractModel):
10910
10902
 
10911
10903
  @property
10912
10904
  def ReportType(self):
10913
- r"""指定申请的报告类型,可选类型如下:
10914
- <ul><li> **0** :合同签署报告(默认)</li>
10915
- <li> **1** :公证处核验报告</li></ul>
10905
+ r"""<p>指定申请的报告类型,可选类型如下:<ul><li> <strong>0</strong> :合同签署报告(默认)</li></ul></p><p>枚举值:</p><ul><li>0: 合同签署报告</li></ul>
10916
10906
  :rtype: int
10917
10907
  """
10918
10908
  return self._ReportType
@@ -10923,7 +10913,7 @@ class CreateFlowEvidenceReportRequest(AbstractModel):
10923
10913
 
10924
10914
  @property
10925
10915
  def HybridEvidenceFlowFile(self):
10926
- r"""混合云模式获取合同文件合并出证,默认:不同意。注:此参数需要联系腾讯电子签运营进行开通后生效
10916
+ r"""<p>混合云模式获取合同文件合并出证,默认:不同意。注:此参数需要联系腾讯电子签运营进行开通后生效</p>
10927
10917
  :rtype: bool
10928
10918
  """
10929
10919
  return self._HybridEvidenceFlowFile
@@ -10960,16 +10950,11 @@ class CreateFlowEvidenceReportResponse(AbstractModel):
10960
10950
 
10961
10951
  def __init__(self):
10962
10952
  r"""
10963
- :param _ReportId: 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
10953
+ :param _ReportId: <p>出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL</p>
10964
10954
  :type ReportId: str
10965
- :param _Status: 出证任务执行的状态, 状态含义如下:
10966
-
10967
- <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
10968
- <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
10969
- <li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
10955
+ :param _Status: <p>出证任务执行的状态, 状态含义如下:</p><ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li><li>**EvidenceStatusSuccess**: 出证任务执行成功</li><li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
10970
10956
  :type Status: str
10971
- :param _ReportUrl: 此字段已经废除,不再使用.
10972
- 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
10957
+ :param _ReportUrl: <p>此字段已经废除,不再使用.<br>出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取</p>
10973
10958
  :type ReportUrl: str
10974
10959
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10975
10960
  :type RequestId: str
@@ -10981,7 +10966,7 @@ class CreateFlowEvidenceReportResponse(AbstractModel):
10981
10966
 
10982
10967
  @property
10983
10968
  def ReportId(self):
10984
- r"""出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
10969
+ r"""<p>出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL</p>
10985
10970
  :rtype: str
10986
10971
  """
10987
10972
  return self._ReportId
@@ -10992,11 +10977,7 @@ class CreateFlowEvidenceReportResponse(AbstractModel):
10992
10977
 
10993
10978
  @property
10994
10979
  def Status(self):
10995
- r"""出证任务执行的状态, 状态含义如下:
10996
-
10997
- <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
10998
- <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
10999
- <li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
10980
+ r"""<p>出证任务执行的状态, 状态含义如下:</p><ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li><li>**EvidenceStatusSuccess**: 出证任务执行成功</li><li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
11000
10981
  :rtype: str
11001
10982
  """
11002
10983
  return self._Status
@@ -11009,8 +10990,7 @@ class CreateFlowEvidenceReportResponse(AbstractModel):
11009
10990
  def ReportUrl(self):
11010
10991
  warnings.warn("parameter `ReportUrl` is deprecated", DeprecationWarning)
11011
10992
 
11012
- r"""此字段已经废除,不再使用.
11013
- 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
10993
+ r"""<p>此字段已经废除,不再使用.<br>出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取</p>
11014
10994
  :rtype: str
11015
10995
  """
11016
10996
  return self._ReportUrl
@@ -15859,8 +15839,10 @@ class CreateOrganizationAuthUrlRequest(AbstractModel):
15859
15839
  :type AuthorizationMethod: list of int non-negative
15860
15840
  :param _HideBizLicense: <p>企业认证页面隐藏上传营业执照<br><img src="https://qcloudimg.tencent-cloud.cn/raw/cf827ce0e2043d8cc85e0735c9cfa3fc.png" alt="image"><br><img src="https://qcloudimg.tencent-cloud.cn/raw/f908cabe71238c78ee8fafc70888a344.png" alt="image"></p>
15861
15841
  :type HideBizLicense: bool
15862
- :param _AddressSame: <p>对方打开链接认证时,公司地址是否要与接口传递上来的保持一致。</p><ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul><p></p><p>p.s. 仅在公司地址(OrganizationAddress)不为空时有效</p>
15842
+ :param _AddressSame: <p>对方打开链接认证时,公司地址是否要与接口传递上来的保持一致。</p><ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时会回显接口传递的值,且不可更改</li></ul>p.s. 仅在公司地址(OrganizationAddress)不为空时有效<p>如下图所示:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/4aa67a434cdf522c04e32f2e1de0382b.png" alt="示例"><p></p></p>
15863
15843
  :type AddressSame: bool
15844
+ :param _BizLicenseSame: <p>对方打开链接认证时,公司营业执照是否要与接口传递上来的保持一致。</p><ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致,用户可以进行修改</li><li><b>true</b>:启用状态,实际认证时回填的信息就是用户传递的值,并且不能修改</li></ul><p></p><p>p.s. 仅在公司营业执照(BusinessLicense)不为空时有效</p>如下图<img src="https://qcloudimg.tencent-cloud.cn/raw/7159637d5a8ac3d92b35813b1fc9660a.png" alt="示例">
15845
+ :type BizLicenseSame: bool
15864
15846
  """
15865
15847
  self._Operator = None
15866
15848
  self._AuthorizationTypes = None
@@ -15892,6 +15874,7 @@ class CreateOrganizationAuthUrlRequest(AbstractModel):
15892
15874
  self._AuthorizationMethod = None
15893
15875
  self._HideBizLicense = None
15894
15876
  self._AddressSame = None
15877
+ self._BizLicenseSame = None
15895
15878
 
15896
15879
  @property
15897
15880
  def Operator(self):
@@ -16214,7 +16197,7 @@ class CreateOrganizationAuthUrlRequest(AbstractModel):
16214
16197
 
16215
16198
  @property
16216
16199
  def AddressSame(self):
16217
- r"""<p>对方打开链接认证时,公司地址是否要与接口传递上来的保持一致。</p><ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时必须与接口传递的信息完全相符。</li></ul><p></p><p>p.s. 仅在公司地址(OrganizationAddress)不为空时有效</p>
16200
+ r"""<p>对方打开链接认证时,公司地址是否要与接口传递上来的保持一致。</p><ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致。</li><li><b>true</b>:启用状态,实际认证时会回显接口传递的值,且不可更改</li></ul>p.s. 仅在公司地址(OrganizationAddress)不为空时有效<p>如下图所示:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/4aa67a434cdf522c04e32f2e1de0382b.png" alt="示例"><p></p></p>
16218
16201
  :rtype: bool
16219
16202
  """
16220
16203
  return self._AddressSame
@@ -16223,6 +16206,17 @@ class CreateOrganizationAuthUrlRequest(AbstractModel):
16223
16206
  def AddressSame(self, AddressSame):
16224
16207
  self._AddressSame = AddressSame
16225
16208
 
16209
+ @property
16210
+ def BizLicenseSame(self):
16211
+ r"""<p>对方打开链接认证时,公司营业执照是否要与接口传递上来的保持一致。</p><ul><li><b>false(默认值)</b>:关闭状态,实际认证时允许与接口传递的信息存在不一致,用户可以进行修改</li><li><b>true</b>:启用状态,实际认证时回填的信息就是用户传递的值,并且不能修改</li></ul><p></p><p>p.s. 仅在公司营业执照(BusinessLicense)不为空时有效</p>如下图<img src="https://qcloudimg.tencent-cloud.cn/raw/7159637d5a8ac3d92b35813b1fc9660a.png" alt="示例">
16212
+ :rtype: bool
16213
+ """
16214
+ return self._BizLicenseSame
16215
+
16216
+ @BizLicenseSame.setter
16217
+ def BizLicenseSame(self, BizLicenseSame):
16218
+ self._BizLicenseSame = BizLicenseSame
16219
+
16226
16220
 
16227
16221
  def _deserialize(self, params):
16228
16222
  if params.get("Operator") is not None:
@@ -16262,6 +16256,7 @@ class CreateOrganizationAuthUrlRequest(AbstractModel):
16262
16256
  self._AuthorizationMethod = params.get("AuthorizationMethod")
16263
16257
  self._HideBizLicense = params.get("HideBizLicense")
16264
16258
  self._AddressSame = params.get("AddressSame")
16259
+ self._BizLicenseSame = params.get("BizLicenseSame")
16265
16260
  memeber_set = set(params.keys())
16266
16261
  for name, value in vars(self).items():
16267
16262
  property_name = name[1:]
@@ -17087,29 +17082,17 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
17087
17082
 
17088
17083
  def __init__(self):
17089
17084
  r"""
17090
- :param _Agent: 代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
17085
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
17091
17086
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
17092
- :param _Operator: 执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
17087
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
17093
17088
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
17094
- :param _AuthorizedOrganizationId: 被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入
17089
+ :param _AuthorizedOrganizationId: <p>被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入</p>
17095
17090
  :type AuthorizedOrganizationId: str
17096
- :param _AuthorizedOrganizationName: 被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
17097
- 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
17091
+ :param _AuthorizedOrganizationName: <p>被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。<br>注: <code>如果名称中包含英文括号(),请使用中文括号()代替。</code></p>
17098
17092
  :type AuthorizedOrganizationName: str
17099
- :param _SealTypes: 在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:
17100
-
17101
- <ul>
17102
- <li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>
17103
- <li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>
17104
- <li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>
17105
- <li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>
17106
- </ul>
17093
+ :param _SealTypes: <p>在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。</p><p>枚举值:</p><ul><li>OFFICIAL: 企业公章,用于代表企业对外的正式文件和重要事务的认证</li><li>CONTRACT: 合同专用章,专门用于签署各类合同。</li><li>FINANCE: 财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证</li><li>PERSONNEL: 人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li><li>OTHER: 其他类型印章,包含子类型</li></ul>
17107
17094
  :type SealTypes: list of str
17108
- :param _AuthToMe: 在处理授权关系时,授权的方向
17109
- <ul>
17110
- <li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
17111
- <li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
17112
- </ul>
17095
+ :param _AuthToMe: <p>在处理授权关系时,授权的方向</p><ul><li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li><li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li></ul>
17113
17096
  :type AuthToMe: bool
17114
17097
  """
17115
17098
  self._Agent = None
@@ -17121,7 +17104,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
17121
17104
 
17122
17105
  @property
17123
17106
  def Agent(self):
17124
- r"""代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
17107
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
17125
17108
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
17126
17109
  """
17127
17110
  return self._Agent
@@ -17132,7 +17115,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
17132
17115
 
17133
17116
  @property
17134
17117
  def Operator(self):
17135
- r"""执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
17118
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
17136
17119
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
17137
17120
  """
17138
17121
  return self._Operator
@@ -17143,7 +17126,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
17143
17126
 
17144
17127
  @property
17145
17128
  def AuthorizedOrganizationId(self):
17146
- r"""被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入
17129
+ r"""<p>被授企业id/授权方企业id(即OrganizationId),和AuthorizedOrganizationName二选一传入</p>
17147
17130
  :rtype: str
17148
17131
  """
17149
17132
  return self._AuthorizedOrganizationId
@@ -17154,8 +17137,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
17154
17137
 
17155
17138
  @property
17156
17139
  def AuthorizedOrganizationName(self):
17157
- r"""被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
17158
- 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
17140
+ r"""<p>被授企业名称/授权方企业的名字,和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。<br>注: <code>如果名称中包含英文括号(),请使用中文括号()代替。</code></p>
17159
17141
  :rtype: str
17160
17142
  """
17161
17143
  return self._AuthorizedOrganizationName
@@ -17166,14 +17148,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
17166
17148
 
17167
17149
  @property
17168
17150
  def SealTypes(self):
17169
- r"""在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:
17170
-
17171
- <ul>
17172
- <li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>
17173
- <li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>
17174
- <li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>
17175
- <li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>
17176
- </ul>
17151
+ r"""<p>在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。</p><p>枚举值:</p><ul><li>OFFICIAL: 企业公章,用于代表企业对外的正式文件和重要事务的认证</li><li>CONTRACT: 合同专用章,专门用于签署各类合同。</li><li>FINANCE: 财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证</li><li>PERSONNEL: 人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li><li>OTHER: 其他类型印章,包含子类型</li></ul>
17177
17152
  :rtype: list of str
17178
17153
  """
17179
17154
  return self._SealTypes
@@ -17184,11 +17159,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
17184
17159
 
17185
17160
  @property
17186
17161
  def AuthToMe(self):
17187
- r"""在处理授权关系时,授权的方向
17188
- <ul>
17189
- <li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
17190
- <li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
17191
- </ul>
17162
+ r"""<p>在处理授权关系时,授权的方向</p><ul><li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li><li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li></ul>
17192
17163
  :rtype: bool
17193
17164
  """
17194
17165
  return self._AuthToMe
@@ -17226,11 +17197,11 @@ class CreatePartnerAutoSignAuthUrlResponse(AbstractModel):
17226
17197
 
17227
17198
  def __init__(self):
17228
17199
  r"""
17229
- :param _Url: 授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
17200
+ :param _Url: <p>授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。</p>
17230
17201
  :type Url: str
17231
- :param _MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
17202
+ :param _MiniAppPath: <p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p>
17232
17203
  :type MiniAppPath: str
17233
- :param _ExpireTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
17204
+ :param _ExpireTime: <p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
17234
17205
  :type ExpireTime: int
17235
17206
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
17236
17207
  :type RequestId: str
@@ -17242,7 +17213,7 @@ class CreatePartnerAutoSignAuthUrlResponse(AbstractModel):
17242
17213
 
17243
17214
  @property
17244
17215
  def Url(self):
17245
- r"""授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
17216
+ r"""<p>授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。</p>
17246
17217
  :rtype: str
17247
17218
  """
17248
17219
  return self._Url
@@ -17253,7 +17224,7 @@ class CreatePartnerAutoSignAuthUrlResponse(AbstractModel):
17253
17224
 
17254
17225
  @property
17255
17226
  def MiniAppPath(self):
17256
- r"""从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
17227
+ r"""<p>从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径</p>
17257
17228
  :rtype: str
17258
17229
  """
17259
17230
  return self._MiniAppPath
@@ -17264,7 +17235,7 @@ class CreatePartnerAutoSignAuthUrlResponse(AbstractModel):
17264
17235
 
17265
17236
  @property
17266
17237
  def ExpireTime(self):
17267
- r"""链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
17238
+ r"""<p>链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。</p>
17268
17239
  :rtype: int
17269
17240
  """
17270
17241
  return self._ExpireTime
@@ -26928,17 +26899,13 @@ class DescribeFlowEvidenceReportRequest(AbstractModel):
26928
26899
 
26929
26900
  def __init__(self):
26930
26901
  r"""
26931
- :param _Operator: 执行本接口操作的员工信息。
26932
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
26902
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
26933
26903
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
26934
- :param _ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
26904
+ :param _ReportId: <p>签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生</p>
26935
26905
  :type ReportId: str
26936
- :param _Agent: 代理企业和员工的信息。
26937
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
26906
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
26938
26907
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
26939
- :param _ReportType: 指定申请的报告类型,可选类型如下:
26940
- <ul><li> **0** :合同签署报告(默认)</li>
26941
- <li> **1** :公证处核验报告</li></ul>
26908
+ :param _ReportType: <p>指定申请的报告类型,可选类型如下:<ul><li> <strong>0</strong> :合同签署报告(默认)</li></ul></p><p>枚举值:</p><ul><li>0: 合同签署报告</li></ul>
26942
26909
  :type ReportType: int
26943
26910
  """
26944
26911
  self._Operator = None
@@ -26948,8 +26915,7 @@ class DescribeFlowEvidenceReportRequest(AbstractModel):
26948
26915
 
26949
26916
  @property
26950
26917
  def Operator(self):
26951
- r"""执行本接口操作的员工信息。
26952
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
26918
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
26953
26919
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
26954
26920
  """
26955
26921
  return self._Operator
@@ -26960,7 +26926,7 @@ class DescribeFlowEvidenceReportRequest(AbstractModel):
26960
26926
 
26961
26927
  @property
26962
26928
  def ReportId(self):
26963
- r"""签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
26929
+ r"""<p>签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生</p>
26964
26930
  :rtype: str
26965
26931
  """
26966
26932
  return self._ReportId
@@ -26971,8 +26937,7 @@ class DescribeFlowEvidenceReportRequest(AbstractModel):
26971
26937
 
26972
26938
  @property
26973
26939
  def Agent(self):
26974
- r"""代理企业和员工的信息。
26975
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
26940
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
26976
26941
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
26977
26942
  """
26978
26943
  return self._Agent
@@ -26983,9 +26948,7 @@ class DescribeFlowEvidenceReportRequest(AbstractModel):
26983
26948
 
26984
26949
  @property
26985
26950
  def ReportType(self):
26986
- r"""指定申请的报告类型,可选类型如下:
26987
- <ul><li> **0** :合同签署报告(默认)</li>
26988
- <li> **1** :公证处核验报告</li></ul>
26951
+ r"""<p>指定申请的报告类型,可选类型如下:<ul><li> <strong>0</strong> :合同签署报告(默认)</li></ul></p><p>枚举值:</p><ul><li>0: 合同签署报告</li></ul>
26989
26952
  :rtype: int
26990
26953
  """
26991
26954
  return self._ReportType
@@ -27021,13 +26984,9 @@ class DescribeFlowEvidenceReportResponse(AbstractModel):
27021
26984
 
27022
26985
  def __init__(self):
27023
26986
  r"""
27024
- :param _ReportUrl: 出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
26987
+ :param _ReportUrl: <p>出证报告PDF的下载 URL,<code>有效期为5分钟</code>,超过有效期后将无法再下载。</p>
27025
26988
  :type ReportUrl: str
27026
- :param _Status: 出证任务执行的状态, 状态含义如下:
27027
-
27028
- <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
27029
- <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
27030
- <li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
26989
+ :param _Status: <p>出证任务执行的状态, 状态含义如下:</p><ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li><li>**EvidenceStatusSuccess**: 出证任务执行成功</li><li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
27031
26990
  :type Status: str
27032
26991
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
27033
26992
  :type RequestId: str
@@ -27038,7 +26997,7 @@ class DescribeFlowEvidenceReportResponse(AbstractModel):
27038
26997
 
27039
26998
  @property
27040
26999
  def ReportUrl(self):
27041
- r"""出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
27000
+ r"""<p>出证报告PDF的下载 URL,<code>有效期为5分钟</code>,超过有效期后将无法再下载。</p>
27042
27001
  :rtype: str
27043
27002
  """
27044
27003
  return self._ReportUrl
@@ -27049,11 +27008,7 @@ class DescribeFlowEvidenceReportResponse(AbstractModel):
27049
27008
 
27050
27009
  @property
27051
27010
  def Status(self):
27052
- r"""出证任务执行的状态, 状态含义如下:
27053
-
27054
- <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
27055
- <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
27056
- <li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
27011
+ r"""<p>出证任务执行的状态, 状态含义如下:</p><ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li><li>**EvidenceStatusSuccess**: 出证任务执行成功</li><li>**EvidenceStatusFailed** : 出证任务执行失败</li></ul>
27057
27012
  :rtype: str
27058
27013
  """
27059
27014
  return self._Status
@@ -27265,44 +27220,27 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27265
27220
 
27266
27221
  def __init__(self):
27267
27222
  r"""
27268
- :param _Operator: 执行本接口操作的员工信息。
27269
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
27223
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
27270
27224
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
27271
- :param _Agent: 代理企业和员工的信息。
27272
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
27225
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
27273
27226
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
27274
- :param _ContentType: 查询内容控制
27275
-
27276
- <ul><li>**0**:模板列表及详情(默认)</li>
27277
- <li>**1**:仅模板列表</li></ul>
27227
+ :param _ContentType: <p>查询内容控制</p><ul><li>**0**:模板列表及详情(默认)</li><li>**1**:仅模板列表</li></ul>
27278
27228
  :type ContentType: int
27279
- :param _Filters: 搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>
27229
+ :param _Filters: <p>搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul></p>
27280
27230
  :type Filters: list of Filter
27281
- :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
27282
-
27283
- 注:`1.offset从0开始,即第一页为0。`
27284
- `2.默认从第一页返回。`
27231
+ :param _Offset: <p>偏移量:从 0 开始,最大20000。</p>
27285
27232
  :type Offset: int
27286
- :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用。
27287
-
27288
- 注:`1.默认值为20,单页做大值为200。`
27233
+ :param _Limit: <p>指定每页返回的数据条数,和Offset参数配合使用。</p><p>注:<code>1.默认值为20,单页做大值为200。</code></p>
27289
27234
  :type Limit: int
27290
- :param _ApplicationId: 通过指定[第三方应用的应用号(ApplicationId)](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png),您可以查询<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中某个第三方应用下的模板。
27291
-
27292
- <p><strong>注意事项:</strong></p>
27293
- <ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href="https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png" target="_blank">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>
27235
+ :param _ApplicationId: <p>通过指定<a href="https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png">第三方应用的应用号(ApplicationId)</a>,您可以查询<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中某个第三方应用下的模板。</p><p><strong>注意事项:</strong></p><ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href="https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png" target="_blank">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>
27294
27236
  :type ApplicationId: str
27295
- :param _IsChannel: 默认为false,查询SaaS模板库列表;
27296
- 为true,查询第三方应用集成平台企业模板库管理列表
27237
+ :param _IsChannel: <p>默认为false,查询SaaS模板库列表;<br>为true,查询第三方应用集成平台企业模板库管理列表</p>
27297
27238
  :type IsChannel: bool
27298
- :param _Organization: 暂未开放
27239
+ :param _Organization: <p>暂未开放</p>
27299
27240
  :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
27300
- :param _GenerateSource: 暂未开放
27241
+ :param _GenerateSource: <p>暂未开放</p>
27301
27242
  :type GenerateSource: int
27302
- :param _WithPreviewUrl: 是否获取模板预览链接。
27303
-
27304
- <ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>
27305
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
27243
+ :param _WithPreviewUrl: <p>是否获取模板预览链接。</p><ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
27306
27244
  :type WithPreviewUrl: bool
27307
27245
  """
27308
27246
  self._Operator = None
@@ -27319,8 +27257,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27319
27257
 
27320
27258
  @property
27321
27259
  def Operator(self):
27322
- r"""执行本接口操作的员工信息。
27323
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
27260
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
27324
27261
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
27325
27262
  """
27326
27263
  return self._Operator
@@ -27331,8 +27268,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27331
27268
 
27332
27269
  @property
27333
27270
  def Agent(self):
27334
- r"""代理企业和员工的信息。
27335
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
27271
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
27336
27272
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
27337
27273
  """
27338
27274
  return self._Agent
@@ -27343,10 +27279,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27343
27279
 
27344
27280
  @property
27345
27281
  def ContentType(self):
27346
- r"""查询内容控制
27347
-
27348
- <ul><li>**0**:模板列表及详情(默认)</li>
27349
- <li>**1**:仅模板列表</li></ul>
27282
+ r"""<p>查询内容控制</p><ul><li>**0**:模板列表及详情(默认)</li><li>**1**:仅模板列表</li></ul>
27350
27283
  :rtype: int
27351
27284
  """
27352
27285
  return self._ContentType
@@ -27357,7 +27290,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27357
27290
 
27358
27291
  @property
27359
27292
  def Filters(self):
27360
- r"""搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>
27293
+ r"""<p>搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>:<strong>Key</strong>设置为 <code>user-flow-type-id</code> ,<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul></p>
27361
27294
  :rtype: list of Filter
27362
27295
  """
27363
27296
  return self._Filters
@@ -27368,10 +27301,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27368
27301
 
27369
27302
  @property
27370
27303
  def Offset(self):
27371
- r"""查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
27372
-
27373
- 注:`1.offset从0开始,即第一页为0。`
27374
- `2.默认从第一页返回。`
27304
+ r"""<p>偏移量:从 0 开始,最大20000。</p>
27375
27305
  :rtype: int
27376
27306
  """
27377
27307
  return self._Offset
@@ -27382,9 +27312,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27382
27312
 
27383
27313
  @property
27384
27314
  def Limit(self):
27385
- r"""指定每页返回的数据条数,和Offset参数配合使用。
27386
-
27387
- 注:`1.默认值为20,单页做大值为200。`
27315
+ r"""<p>指定每页返回的数据条数,和Offset参数配合使用。</p><p>注:<code>1.默认值为20,单页做大值为200。</code></p>
27388
27316
  :rtype: int
27389
27317
  """
27390
27318
  return self._Limit
@@ -27395,10 +27323,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27395
27323
 
27396
27324
  @property
27397
27325
  def ApplicationId(self):
27398
- r"""通过指定[第三方应用的应用号(ApplicationId)](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png),您可以查询<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中某个第三方应用下的模板。
27399
-
27400
- <p><strong>注意事项:</strong></p>
27401
- <ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href="https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png" target="_blank">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>
27326
+ r"""<p>通过指定<a href="https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png">第三方应用的应用号(ApplicationId)</a>,您可以查询<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中某个第三方应用下的模板。</p><p><strong>注意事项:</strong></p><ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href="https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png" target="_blank">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href="https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png" target="_blank">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>
27402
27327
  :rtype: str
27403
27328
  """
27404
27329
  return self._ApplicationId
@@ -27411,8 +27336,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27411
27336
  def IsChannel(self):
27412
27337
  warnings.warn("parameter `IsChannel` is deprecated", DeprecationWarning)
27413
27338
 
27414
- r"""默认为false,查询SaaS模板库列表;
27415
- 为true,查询第三方应用集成平台企业模板库管理列表
27339
+ r"""<p>默认为false,查询SaaS模板库列表;<br>为true,查询第三方应用集成平台企业模板库管理列表</p>
27416
27340
  :rtype: bool
27417
27341
  """
27418
27342
  return self._IsChannel
@@ -27427,7 +27351,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27427
27351
  def Organization(self):
27428
27352
  warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
27429
27353
 
27430
- r"""暂未开放
27354
+ r"""<p>暂未开放</p>
27431
27355
  :rtype: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
27432
27356
  """
27433
27357
  return self._Organization
@@ -27442,7 +27366,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27442
27366
  def GenerateSource(self):
27443
27367
  warnings.warn("parameter `GenerateSource` is deprecated", DeprecationWarning)
27444
27368
 
27445
- r"""暂未开放
27369
+ r"""<p>暂未开放</p>
27446
27370
  :rtype: int
27447
27371
  """
27448
27372
  return self._GenerateSource
@@ -27455,10 +27379,7 @@ class DescribeFlowTemplatesRequest(AbstractModel):
27455
27379
 
27456
27380
  @property
27457
27381
  def WithPreviewUrl(self):
27458
- r"""是否获取模板预览链接。
27459
-
27460
- <ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>
27461
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
27382
+ r"""<p>是否获取模板预览链接。</p><ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
27462
27383
  :rtype: bool
27463
27384
  """
27464
27385
  return self._WithPreviewUrl
@@ -27508,9 +27429,9 @@ class DescribeFlowTemplatesResponse(AbstractModel):
27508
27429
 
27509
27430
  def __init__(self):
27510
27431
  r"""
27511
- :param _Templates: 模板详情列表数据
27432
+ :param _Templates: <p>模板详情列表数据</p>
27512
27433
  :type Templates: list of TemplateInfo
27513
- :param _TotalCount: 查询到的模板总数
27434
+ :param _TotalCount: <p>查询到的模板总数</p>
27514
27435
  :type TotalCount: int
27515
27436
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
27516
27437
  :type RequestId: str
@@ -27521,7 +27442,7 @@ class DescribeFlowTemplatesResponse(AbstractModel):
27521
27442
 
27522
27443
  @property
27523
27444
  def Templates(self):
27524
- r"""模板详情列表数据
27445
+ r"""<p>模板详情列表数据</p>
27525
27446
  :rtype: list of TemplateInfo
27526
27447
  """
27527
27448
  return self._Templates
@@ -27532,7 +27453,7 @@ class DescribeFlowTemplatesResponse(AbstractModel):
27532
27453
 
27533
27454
  @property
27534
27455
  def TotalCount(self):
27535
- r"""查询到的模板总数
27456
+ r"""<p>查询到的模板总数</p>
27536
27457
  :rtype: int
27537
27458
  """
27538
27459
  return self._TotalCount
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.136
3
+ Version: 3.1.140
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.136
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.140
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.140
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.136