tencentcloud-sdk-python-ess 3.1.82__tar.gz → 3.1.86__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.82 → tencentcloud_sdk_python_ess-3.1.86}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/setup.py +1 -1
  3. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud/ess/v20201111/ess_client.py +39 -0
  5. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud/ess/v20201111/ess_client_async.py +34 -0
  6. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud/ess/v20201111/models.py +286 -88
  7. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
  8. tencentcloud_sdk_python_ess-3.1.86/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
  9. tencentcloud_sdk_python_ess-3.1.82/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
  10. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/README.rst +0 -0
  11. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/setup.cfg +0 -0
  12. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud/ess/__init__.py +0 -0
  13. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud/ess/v20201111/__init__.py +0 -0
  14. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
  15. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_ess-3.1.82 → tencentcloud_sdk_python_ess-3.1.86}/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.82
3
+ Version: 3.1.86
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.82
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.86
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.82,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.86,<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.82'
17
+ __version__ = '3.1.86'
@@ -4202,6 +4202,45 @@ class EssClient(AbstractClient):
4202
4202
  raise TencentCloudSDKException(type(e).__name__, str(e))
4203
4203
 
4204
4204
 
4205
+ def OperateFlowRemarks(self, request):
4206
+ r"""此接口(OperateFlowRemarks)用于对企业合同备注进行管理操作,支持新增,创建和删除。
4207
+
4208
+
4209
+ 用户可以通过接口对合同备注进行管理,支持对创建后的备注进行搜索关联的合同流程。
4210
+
4211
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/cac8af24804ab4f7455be2d5b39a43e5.png)
4212
+
4213
+ 注:
4214
+
4215
+ 对合同备注进行操作前,操作人需要获取对应权限:合同操作 - 设置合同类型及备注。
4216
+
4217
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ce4f0ca867ab5020f4fdfecc39050f0f.png)
4218
+
4219
+
4220
+ 没有对应权限的用户,并且不属于超管、法人,该合同的参与方(包含签署方与发起方),将无法对对应合同的备注进行编辑,如果备注内容包含敏感信息,将会对其进行打码显示。
4221
+
4222
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/e5ef298c41f999b656f6b620c8b3d888.png)
4223
+
4224
+ :param request: Request instance for OperateFlowRemarks.
4225
+ :type request: :class:`tencentcloud.ess.v20201111.models.OperateFlowRemarksRequest`
4226
+ :rtype: :class:`tencentcloud.ess.v20201111.models.OperateFlowRemarksResponse`
4227
+
4228
+ """
4229
+ try:
4230
+ params = request._serialize()
4231
+ headers = request.headers
4232
+ body = self.call("OperateFlowRemarks", params, headers=headers)
4233
+ response = json.loads(body)
4234
+ model = models.OperateFlowRemarksResponse()
4235
+ model._deserialize(response["Response"])
4236
+ return model
4237
+ except Exception as e:
4238
+ if isinstance(e, TencentCloudSDKException):
4239
+ raise
4240
+ else:
4241
+ raise TencentCloudSDKException(type(e).__name__, str(e))
4242
+
4243
+
4205
4244
  def OperateSeals(self, request):
4206
4245
  r"""修改印章状态(停用、启用)
4207
4246
 
@@ -3516,6 +3516,40 @@ class EssClient(AbstractClient):
3516
3516
 
3517
3517
  return await self.call_and_deserialize(**kwargs)
3518
3518
 
3519
+ async def OperateFlowRemarks(
3520
+ self,
3521
+ request: models.OperateFlowRemarksRequest,
3522
+ opts: Dict = None,
3523
+ ) -> models.OperateFlowRemarksResponse:
3524
+ """
3525
+ 此接口(OperateFlowRemarks)用于对企业合同备注进行管理操作,支持新增,创建和删除。
3526
+
3527
+
3528
+ 用户可以通过接口对合同备注进行管理,支持对创建后的备注进行搜索关联的合同流程。
3529
+
3530
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/cac8af24804ab4f7455be2d5b39a43e5.png)
3531
+
3532
+ 注:
3533
+
3534
+ 对合同备注进行操作前,操作人需要获取对应权限:合同操作 - 设置合同类型及备注。
3535
+
3536
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ce4f0ca867ab5020f4fdfecc39050f0f.png)
3537
+
3538
+
3539
+ 没有对应权限的用户,并且不属于超管、法人,该合同的参与方(包含签署方与发起方),将无法对对应合同的备注进行编辑,如果备注内容包含敏感信息,将会对其进行打码显示。
3540
+
3541
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/e5ef298c41f999b656f6b620c8b3d888.png)
3542
+ """
3543
+
3544
+ kwargs = {}
3545
+ kwargs["action"] = "OperateFlowRemarks"
3546
+ kwargs["params"] = request._serialize()
3547
+ kwargs["resp_cls"] = models.OperateFlowRemarksResponse
3548
+ kwargs["headers"] = request.headers
3549
+ kwargs["opts"] = opts or {}
3550
+
3551
+ return await self.call_and_deserialize(**kwargs)
3552
+
3519
3553
  async def OperateSeals(
3520
3554
  self,
3521
3555
  request: models.OperateSealsRequest,
@@ -26356,19 +26356,13 @@ class DescribeFlowInfoRequest(AbstractModel):
26356
26356
 
26357
26357
  def __init__(self):
26358
26358
  r"""
26359
- :param _Operator: 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
26359
+ :param _Operator: <p>执行本接口操作的员工信息。 注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
26360
26360
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
26361
- :param _FlowIds: 需要查询的流程ID列表,最多可传入100个ID
26362
- 如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。
26363
-
26364
-
26365
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
26366
-
26367
- [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
26361
+ :param _FlowIds: <p>需要查询的流程ID列表,最多可传入100个ID。<br>如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。</p><p>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
26368
26362
  :type FlowIds: list of str
26369
- :param _Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
26363
+ :param _Agent: <p>代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
26370
26364
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
26371
- :param _FlowGroupId: 需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。该合同组由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
26365
+ :param _FlowGroupId: <p>需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。该合同组由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。</p>
26372
26366
  :type FlowGroupId: str
26373
26367
  """
26374
26368
  self._Operator = None
@@ -26378,7 +26372,7 @@ class DescribeFlowInfoRequest(AbstractModel):
26378
26372
 
26379
26373
  @property
26380
26374
  def Operator(self):
26381
- r"""执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
26375
+ r"""<p>执行本接口操作的员工信息。 注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
26382
26376
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
26383
26377
  """
26384
26378
  return self._Operator
@@ -26389,13 +26383,7 @@ class DescribeFlowInfoRequest(AbstractModel):
26389
26383
 
26390
26384
  @property
26391
26385
  def FlowIds(self):
26392
- r"""需要查询的流程ID列表,最多可传入100个ID
26393
- 如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。
26394
-
26395
-
26396
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
26397
-
26398
- [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
26386
+ r"""<p>需要查询的流程ID列表,最多可传入100个ID。<br>如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。</p><p>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png">点击查看FlowId在控制台中的位置</a></p>
26399
26387
  :rtype: list of str
26400
26388
  """
26401
26389
  return self._FlowIds
@@ -26406,7 +26394,7 @@ class DescribeFlowInfoRequest(AbstractModel):
26406
26394
 
26407
26395
  @property
26408
26396
  def Agent(self):
26409
- r"""代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
26397
+ r"""<p>代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
26410
26398
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
26411
26399
  """
26412
26400
  return self._Agent
@@ -26417,7 +26405,7 @@ class DescribeFlowInfoRequest(AbstractModel):
26417
26405
 
26418
26406
  @property
26419
26407
  def FlowGroupId(self):
26420
- r"""需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。该合同组由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
26408
+ r"""<p>需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。该合同组由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。</p>
26421
26409
  :rtype: str
26422
26410
  """
26423
26411
  return self._FlowGroupId
@@ -26453,25 +26441,26 @@ class DescribeFlowInfoResponse(AbstractModel):
26453
26441
 
26454
26442
  def __init__(self):
26455
26443
  r"""
26456
- :param _FlowDetailInfos: 合同流程的详细信息。
26457
- 如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。
26444
+ :param _FlowDetailInfos: <p>合同流程的详细信息。<br>如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。</p>
26458
26445
  :type FlowDetailInfos: list of FlowDetailInfo
26459
- :param _FlowGroupId: 合同组ID,只有在查询合同组信息时才会返回。
26446
+ :param _FlowGroupId: <p>合同组ID,只有在查询合同组信息时才会返回。</p>
26460
26447
  :type FlowGroupId: str
26461
- :param _FlowGroupName: 合同组名称,只有在查询合同组信息时才会返回。
26448
+ :param _FlowGroupName: <p>合同组名称,只有在查询合同组信息时才会返回。</p>
26462
26449
  :type FlowGroupName: str
26450
+ :param _FlowGroupRemarks: <p>合同组合同备注列表</p>
26451
+ :type FlowGroupRemarks: list of str
26463
26452
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
26464
26453
  :type RequestId: str
26465
26454
  """
26466
26455
  self._FlowDetailInfos = None
26467
26456
  self._FlowGroupId = None
26468
26457
  self._FlowGroupName = None
26458
+ self._FlowGroupRemarks = None
26469
26459
  self._RequestId = None
26470
26460
 
26471
26461
  @property
26472
26462
  def FlowDetailInfos(self):
26473
- r"""合同流程的详细信息。
26474
- 如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。
26463
+ r"""<p>合同流程的详细信息。<br>如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。</p>
26475
26464
  :rtype: list of FlowDetailInfo
26476
26465
  """
26477
26466
  return self._FlowDetailInfos
@@ -26482,7 +26471,7 @@ class DescribeFlowInfoResponse(AbstractModel):
26482
26471
 
26483
26472
  @property
26484
26473
  def FlowGroupId(self):
26485
- r"""合同组ID,只有在查询合同组信息时才会返回。
26474
+ r"""<p>合同组ID,只有在查询合同组信息时才会返回。</p>
26486
26475
  :rtype: str
26487
26476
  """
26488
26477
  return self._FlowGroupId
@@ -26493,7 +26482,7 @@ class DescribeFlowInfoResponse(AbstractModel):
26493
26482
 
26494
26483
  @property
26495
26484
  def FlowGroupName(self):
26496
- r"""合同组名称,只有在查询合同组信息时才会返回。
26485
+ r"""<p>合同组名称,只有在查询合同组信息时才会返回。</p>
26497
26486
  :rtype: str
26498
26487
  """
26499
26488
  return self._FlowGroupName
@@ -26502,6 +26491,17 @@ class DescribeFlowInfoResponse(AbstractModel):
26502
26491
  def FlowGroupName(self, FlowGroupName):
26503
26492
  self._FlowGroupName = FlowGroupName
26504
26493
 
26494
+ @property
26495
+ def FlowGroupRemarks(self):
26496
+ r"""<p>合同组合同备注列表</p>
26497
+ :rtype: list of str
26498
+ """
26499
+ return self._FlowGroupRemarks
26500
+
26501
+ @FlowGroupRemarks.setter
26502
+ def FlowGroupRemarks(self, FlowGroupRemarks):
26503
+ self._FlowGroupRemarks = FlowGroupRemarks
26504
+
26505
26505
  @property
26506
26506
  def RequestId(self):
26507
26507
  r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -26523,6 +26523,7 @@ class DescribeFlowInfoResponse(AbstractModel):
26523
26523
  self._FlowDetailInfos.append(obj)
26524
26524
  self._FlowGroupId = params.get("FlowGroupId")
26525
26525
  self._FlowGroupName = params.get("FlowGroupName")
26526
+ self._FlowGroupRemarks = params.get("FlowGroupRemarks")
26526
26527
  self._RequestId = params.get("RequestId")
26527
26528
 
26528
26529
 
@@ -33639,48 +33640,32 @@ class FlowDetailInfo(AbstractModel):
33639
33640
 
33640
33641
  def __init__(self):
33641
33642
  r"""
33642
- :param _FlowId: 合同流程ID,为32位字符串。
33643
+ :param _FlowId: <p>合同流程ID,为32位字符串。</p>
33643
33644
  :type FlowId: str
33644
- :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
33645
+ :param _FlowName: <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
33645
33646
  :type FlowName: str
33646
- :param _FlowType: 合同流程的类别分类(如销售合同/入职合同等)。
33647
- 该字段将被废弃,不建议使用。
33647
+ :param _FlowType: <p>合同流程的类别分类(如销售合同/入职合同等)。<br>该字段将被废弃,不建议使用。</p>
33648
33648
  :type FlowType: str
33649
- :param _FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
33650
- <ul>
33651
- <li> **0** : 未开启流程(合同中不存在填写环节)</li>
33652
- <li> **1** : 待签署</li>
33653
- <li> **2** : 部分签署</li>
33654
- <li> **3** : 已拒签</li>
33655
- <li> **4** : 已签署</li>
33656
- <li> **5** : 已过期</li>
33657
- <li> **6** : 已撤销</li>
33658
- <li> **7** : 未开启流程(合同中存在填写环节)</li>
33659
- <li> **8** : 等待填写</li>
33660
- <li> **9** : 部分填写</li>
33661
- <li> **10** : 已拒填</li>
33662
- <li> **16** : 已失效(可能因为参与方修改姓名等原因)</li>
33663
- <li> **21** : 已解除</li></ul>
33649
+ :param _FlowStatus: <p>合同流程当前的签署状态, 会存在下列的状态值 </p><ul><li> **0** : 未开启流程(合同中不存在填写环节)</li> <li> **1** : 待签署</li> <li> **2** : 部分签署</li> <li> **3** : 已拒签</li> <li> **4** : 已签署</li> <li> **5** : 已过期</li> <li> **6** : 已撤销</li> <li> **7** : 未开启流程(合同中存在填写环节)</li> <li> **8** : 等待填写</li> <li> **9** : 部分填写</li> <li> **10** : 已拒填</li> <li> **16** : 已失效(可能因为参与方修改姓名等原因)</li> <li> **21** : 已解除</li></ul>
33664
33650
  :type FlowStatus: int
33665
- :param _FlowMessage: 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
33651
+ :param _FlowMessage: <p>当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。</p>
33666
33652
  :type FlowMessage: str
33667
- :param _FlowDescription: 合同流程描述信息。
33653
+ :param _FlowDescription: <p>合同流程描述信息。</p>
33668
33654
  :type FlowDescription: str
33669
- :param _CreatedOn: 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
33655
+ :param _CreatedOn: <p>合同流程的创建时间戳,格式为Unix标准时间戳(秒)。</p>
33670
33656
  :type CreatedOn: int
33671
- :param _FlowApproverInfos: 合同流程的签署方数组
33657
+ :param _FlowApproverInfos: <p>合同流程的签署方数组</p>
33672
33658
  :type FlowApproverInfos: list of FlowApproverDetail
33673
- :param _CcInfos: 合同流程的关注方信息数组
33659
+ :param _CcInfos: <p>合同流程的关注方信息数组</p>
33674
33660
  :type CcInfos: list of FlowApproverDetail
33675
- :param _Creator: 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
33661
+ :param _Creator: <p>合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。</p>
33676
33662
  :type Creator: str
33677
- :param _UserFlowType: 用户合同的自定义分类。
33678
-
33679
- 自定义合同类型的位置,在下图所示地方:
33680
- ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
33663
+ :param _UserFlowType: <p>用户合同的自定义分类。</p><p>自定义合同类型的位置,在下图所示地方:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png" alt="image"></p>
33681
33664
  :type UserFlowType: :class:`tencentcloud.ess.v20201111.models.UserFlowType`
33682
- :param _TemplateId: 发起模板时,使用的模板Id
33665
+ :param _TemplateId: <p>发起模板时,使用的模板Id</p>
33683
33666
  :type TemplateId: str
33667
+ :param _FlowRemarks: <p>合同备注列表</p>
33668
+ :type FlowRemarks: list of str
33684
33669
  """
33685
33670
  self._FlowId = None
33686
33671
  self._FlowName = None
@@ -33694,10 +33679,11 @@ class FlowDetailInfo(AbstractModel):
33694
33679
  self._Creator = None
33695
33680
  self._UserFlowType = None
33696
33681
  self._TemplateId = None
33682
+ self._FlowRemarks = None
33697
33683
 
33698
33684
  @property
33699
33685
  def FlowId(self):
33700
- r"""合同流程ID,为32位字符串。
33686
+ r"""<p>合同流程ID,为32位字符串。</p>
33701
33687
  :rtype: str
33702
33688
  """
33703
33689
  return self._FlowId
@@ -33708,7 +33694,7 @@ class FlowDetailInfo(AbstractModel):
33708
33694
 
33709
33695
  @property
33710
33696
  def FlowName(self):
33711
- r"""合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
33697
+ r"""<p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
33712
33698
  :rtype: str
33713
33699
  """
33714
33700
  return self._FlowName
@@ -33719,8 +33705,7 @@ class FlowDetailInfo(AbstractModel):
33719
33705
 
33720
33706
  @property
33721
33707
  def FlowType(self):
33722
- r"""合同流程的类别分类(如销售合同/入职合同等)。
33723
- 该字段将被废弃,不建议使用。
33708
+ r"""<p>合同流程的类别分类(如销售合同/入职合同等)。<br>该字段将被废弃,不建议使用。</p>
33724
33709
  :rtype: str
33725
33710
  """
33726
33711
  return self._FlowType
@@ -33731,21 +33716,7 @@ class FlowDetailInfo(AbstractModel):
33731
33716
 
33732
33717
  @property
33733
33718
  def FlowStatus(self):
33734
- r"""合同流程当前的签署状态, 会存在下列的状态值
33735
- <ul>
33736
- <li> **0** : 未开启流程(合同中不存在填写环节)</li>
33737
- <li> **1** : 待签署</li>
33738
- <li> **2** : 部分签署</li>
33739
- <li> **3** : 已拒签</li>
33740
- <li> **4** : 已签署</li>
33741
- <li> **5** : 已过期</li>
33742
- <li> **6** : 已撤销</li>
33743
- <li> **7** : 未开启流程(合同中存在填写环节)</li>
33744
- <li> **8** : 等待填写</li>
33745
- <li> **9** : 部分填写</li>
33746
- <li> **10** : 已拒填</li>
33747
- <li> **16** : 已失效(可能因为参与方修改姓名等原因)</li>
33748
- <li> **21** : 已解除</li></ul>
33719
+ r"""<p>合同流程当前的签署状态, 会存在下列的状态值 </p><ul><li> **0** : 未开启流程(合同中不存在填写环节)</li> <li> **1** : 待签署</li> <li> **2** : 部分签署</li> <li> **3** : 已拒签</li> <li> **4** : 已签署</li> <li> **5** : 已过期</li> <li> **6** : 已撤销</li> <li> **7** : 未开启流程(合同中存在填写环节)</li> <li> **8** : 等待填写</li> <li> **9** : 部分填写</li> <li> **10** : 已拒填</li> <li> **16** : 已失效(可能因为参与方修改姓名等原因)</li> <li> **21** : 已解除</li></ul>
33749
33720
  :rtype: int
33750
33721
  """
33751
33722
  return self._FlowStatus
@@ -33756,7 +33727,7 @@ class FlowDetailInfo(AbstractModel):
33756
33727
 
33757
33728
  @property
33758
33729
  def FlowMessage(self):
33759
- r"""当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
33730
+ r"""<p>当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。</p>
33760
33731
  :rtype: str
33761
33732
  """
33762
33733
  return self._FlowMessage
@@ -33767,7 +33738,7 @@ class FlowDetailInfo(AbstractModel):
33767
33738
 
33768
33739
  @property
33769
33740
  def FlowDescription(self):
33770
- r"""合同流程描述信息。
33741
+ r"""<p>合同流程描述信息。</p>
33771
33742
  :rtype: str
33772
33743
  """
33773
33744
  return self._FlowDescription
@@ -33778,7 +33749,7 @@ class FlowDetailInfo(AbstractModel):
33778
33749
 
33779
33750
  @property
33780
33751
  def CreatedOn(self):
33781
- r"""合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
33752
+ r"""<p>合同流程的创建时间戳,格式为Unix标准时间戳(秒)。</p>
33782
33753
  :rtype: int
33783
33754
  """
33784
33755
  return self._CreatedOn
@@ -33789,7 +33760,7 @@ class FlowDetailInfo(AbstractModel):
33789
33760
 
33790
33761
  @property
33791
33762
  def FlowApproverInfos(self):
33792
- r"""合同流程的签署方数组
33763
+ r"""<p>合同流程的签署方数组</p>
33793
33764
  :rtype: list of FlowApproverDetail
33794
33765
  """
33795
33766
  return self._FlowApproverInfos
@@ -33800,7 +33771,7 @@ class FlowDetailInfo(AbstractModel):
33800
33771
 
33801
33772
  @property
33802
33773
  def CcInfos(self):
33803
- r"""合同流程的关注方信息数组
33774
+ r"""<p>合同流程的关注方信息数组</p>
33804
33775
  :rtype: list of FlowApproverDetail
33805
33776
  """
33806
33777
  return self._CcInfos
@@ -33811,7 +33782,7 @@ class FlowDetailInfo(AbstractModel):
33811
33782
 
33812
33783
  @property
33813
33784
  def Creator(self):
33814
- r"""合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
33785
+ r"""<p>合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。</p>
33815
33786
  :rtype: str
33816
33787
  """
33817
33788
  return self._Creator
@@ -33822,10 +33793,7 @@ class FlowDetailInfo(AbstractModel):
33822
33793
 
33823
33794
  @property
33824
33795
  def UserFlowType(self):
33825
- r"""用户合同的自定义分类。
33826
-
33827
- 自定义合同类型的位置,在下图所示地方:
33828
- ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
33796
+ r"""<p>用户合同的自定义分类。</p><p>自定义合同类型的位置,在下图所示地方:<br><img src="https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png" alt="image"></p>
33829
33797
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserFlowType`
33830
33798
  """
33831
33799
  return self._UserFlowType
@@ -33836,7 +33804,7 @@ class FlowDetailInfo(AbstractModel):
33836
33804
 
33837
33805
  @property
33838
33806
  def TemplateId(self):
33839
- r"""发起模板时,使用的模板Id
33807
+ r"""<p>发起模板时,使用的模板Id</p>
33840
33808
  :rtype: str
33841
33809
  """
33842
33810
  return self._TemplateId
@@ -33845,6 +33813,17 @@ class FlowDetailInfo(AbstractModel):
33845
33813
  def TemplateId(self, TemplateId):
33846
33814
  self._TemplateId = TemplateId
33847
33815
 
33816
+ @property
33817
+ def FlowRemarks(self):
33818
+ r"""<p>合同备注列表</p>
33819
+ :rtype: list of str
33820
+ """
33821
+ return self._FlowRemarks
33822
+
33823
+ @FlowRemarks.setter
33824
+ def FlowRemarks(self, FlowRemarks):
33825
+ self._FlowRemarks = FlowRemarks
33826
+
33848
33827
 
33849
33828
  def _deserialize(self, params):
33850
33829
  self._FlowId = params.get("FlowId")
@@ -33871,6 +33850,7 @@ class FlowDetailInfo(AbstractModel):
33871
33850
  self._UserFlowType = UserFlowType()
33872
33851
  self._UserFlowType._deserialize(params.get("UserFlowType"))
33873
33852
  self._TemplateId = params.get("TemplateId")
33853
+ self._FlowRemarks = params.get("FlowRemarks")
33874
33854
  memeber_set = set(params.keys())
33875
33855
  for name, value in vars(self).items():
33876
33856
  property_name = name[1:]
@@ -34557,6 +34537,57 @@ class FlowOperateLimit(AbstractModel):
34557
34537
 
34558
34538
 
34559
34539
 
34540
+ class FlowRemarkItem(AbstractModel):
34541
+ r"""合同备注
34542
+
34543
+ """
34544
+
34545
+ def __init__(self):
34546
+ r"""
34547
+ :param _RemarkId: <p>合同备注下标,对应最多5个备注位</p><p>取值范围:[0, 4]</p>
34548
+ :type RemarkId: int
34549
+ :param _RemarkValue: <p>合同备注内容,不超过 50 个字符,DELETE 时无需传入</p>
34550
+ :type RemarkValue: str
34551
+ """
34552
+ self._RemarkId = None
34553
+ self._RemarkValue = None
34554
+
34555
+ @property
34556
+ def RemarkId(self):
34557
+ r"""<p>合同备注下标,对应最多5个备注位</p><p>取值范围:[0, 4]</p>
34558
+ :rtype: int
34559
+ """
34560
+ return self._RemarkId
34561
+
34562
+ @RemarkId.setter
34563
+ def RemarkId(self, RemarkId):
34564
+ self._RemarkId = RemarkId
34565
+
34566
+ @property
34567
+ def RemarkValue(self):
34568
+ r"""<p>合同备注内容,不超过 50 个字符,DELETE 时无需传入</p>
34569
+ :rtype: str
34570
+ """
34571
+ return self._RemarkValue
34572
+
34573
+ @RemarkValue.setter
34574
+ def RemarkValue(self, RemarkValue):
34575
+ self._RemarkValue = RemarkValue
34576
+
34577
+
34578
+ def _deserialize(self, params):
34579
+ self._RemarkId = params.get("RemarkId")
34580
+ self._RemarkValue = params.get("RemarkValue")
34581
+ memeber_set = set(params.keys())
34582
+ for name, value in vars(self).items():
34583
+ property_name = name[1:]
34584
+ if property_name in memeber_set:
34585
+ memeber_set.remove(property_name)
34586
+ if len(memeber_set) > 0:
34587
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
34588
+
34589
+
34590
+
34560
34591
  class FormField(AbstractModel):
34561
34592
  r"""电子文档的控件填充信息。按照控件类型进行相应的填充。
34562
34593
 
@@ -34633,6 +34664,13 @@ class FormField(AbstractModel):
34633
34664
  "ComponentValue": "选择的内容"
34634
34665
  }
34635
34666
  ```
34667
+ 多选需要用“、”分割选项
34668
+ ```
34669
+ {
34670
+ "ComponentId": "componentId1",
34671
+ "ComponentValue": "选项1、选项2"
34672
+ }
34673
+ ```
34636
34674
 
34637
34675
  当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
34638
34676
 
@@ -38841,6 +38879,166 @@ class OccupiedSeal(AbstractModel):
38841
38879
 
38842
38880
 
38843
38881
 
38882
+ class OperateFlowRemarksRequest(AbstractModel):
38883
+ r"""OperateFlowRemarks请求参数结构体
38884
+
38885
+ """
38886
+
38887
+ def __init__(self):
38888
+ r"""
38889
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
38890
+ :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
38891
+ :param _OperateType: <p>指定对合同备注的操作</p><p>枚举值:</p><ul><li>CREATE: 创建合同备注</li><li>UPDATE: 更新合同备注</li><li>DELETE: 删除合同备注</li></ul>
38892
+ :type OperateType: str
38893
+ :param _FlowId: <p>对应的合同流程id</p><p>目标合同为合同组时此参数不填</p>
38894
+ :type FlowId: str
38895
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
38896
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
38897
+ :param _FlowGroupId: <p>对应合同组id</p><p>目标合同为单份合同时此参数不填</p>
38898
+ :type FlowGroupId: str
38899
+ :param _FlowItem: <p>合同备注信息。</p><p>入参限制:当OperateType为UPDATE和DELETE时,通过该结构体进行对应备注操作,合同备注数量范围为 1 - 5个。</p>
38900
+ :type FlowItem: :class:`tencentcloud.ess.v20201111.models.FlowRemarkItem`
38901
+ :param _FlowItems: <p>合同备注列表。</p><p>入参限制:当OperateType为CREATE时,通过该参数进行全量的合同备注创建。</p>
38902
+ :type FlowItems: list of str
38903
+ """
38904
+ self._Operator = None
38905
+ self._OperateType = None
38906
+ self._FlowId = None
38907
+ self._Agent = None
38908
+ self._FlowGroupId = None
38909
+ self._FlowItem = None
38910
+ self._FlowItems = None
38911
+
38912
+ @property
38913
+ def Operator(self):
38914
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
38915
+ :rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
38916
+ """
38917
+ return self._Operator
38918
+
38919
+ @Operator.setter
38920
+ def Operator(self, Operator):
38921
+ self._Operator = Operator
38922
+
38923
+ @property
38924
+ def OperateType(self):
38925
+ r"""<p>指定对合同备注的操作</p><p>枚举值:</p><ul><li>CREATE: 创建合同备注</li><li>UPDATE: 更新合同备注</li><li>DELETE: 删除合同备注</li></ul>
38926
+ :rtype: str
38927
+ """
38928
+ return self._OperateType
38929
+
38930
+ @OperateType.setter
38931
+ def OperateType(self, OperateType):
38932
+ self._OperateType = OperateType
38933
+
38934
+ @property
38935
+ def FlowId(self):
38936
+ r"""<p>对应的合同流程id</p><p>目标合同为合同组时此参数不填</p>
38937
+ :rtype: str
38938
+ """
38939
+ return self._FlowId
38940
+
38941
+ @FlowId.setter
38942
+ def FlowId(self, FlowId):
38943
+ self._FlowId = FlowId
38944
+
38945
+ @property
38946
+ def Agent(self):
38947
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
38948
+ :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
38949
+ """
38950
+ return self._Agent
38951
+
38952
+ @Agent.setter
38953
+ def Agent(self, Agent):
38954
+ self._Agent = Agent
38955
+
38956
+ @property
38957
+ def FlowGroupId(self):
38958
+ r"""<p>对应合同组id</p><p>目标合同为单份合同时此参数不填</p>
38959
+ :rtype: str
38960
+ """
38961
+ return self._FlowGroupId
38962
+
38963
+ @FlowGroupId.setter
38964
+ def FlowGroupId(self, FlowGroupId):
38965
+ self._FlowGroupId = FlowGroupId
38966
+
38967
+ @property
38968
+ def FlowItem(self):
38969
+ r"""<p>合同备注信息。</p><p>入参限制:当OperateType为UPDATE和DELETE时,通过该结构体进行对应备注操作,合同备注数量范围为 1 - 5个。</p>
38970
+ :rtype: :class:`tencentcloud.ess.v20201111.models.FlowRemarkItem`
38971
+ """
38972
+ return self._FlowItem
38973
+
38974
+ @FlowItem.setter
38975
+ def FlowItem(self, FlowItem):
38976
+ self._FlowItem = FlowItem
38977
+
38978
+ @property
38979
+ def FlowItems(self):
38980
+ r"""<p>合同备注列表。</p><p>入参限制:当OperateType为CREATE时,通过该参数进行全量的合同备注创建。</p>
38981
+ :rtype: list of str
38982
+ """
38983
+ return self._FlowItems
38984
+
38985
+ @FlowItems.setter
38986
+ def FlowItems(self, FlowItems):
38987
+ self._FlowItems = FlowItems
38988
+
38989
+
38990
+ def _deserialize(self, params):
38991
+ if params.get("Operator") is not None:
38992
+ self._Operator = UserInfo()
38993
+ self._Operator._deserialize(params.get("Operator"))
38994
+ self._OperateType = params.get("OperateType")
38995
+ self._FlowId = params.get("FlowId")
38996
+ if params.get("Agent") is not None:
38997
+ self._Agent = Agent()
38998
+ self._Agent._deserialize(params.get("Agent"))
38999
+ self._FlowGroupId = params.get("FlowGroupId")
39000
+ if params.get("FlowItem") is not None:
39001
+ self._FlowItem = FlowRemarkItem()
39002
+ self._FlowItem._deserialize(params.get("FlowItem"))
39003
+ self._FlowItems = params.get("FlowItems")
39004
+ memeber_set = set(params.keys())
39005
+ for name, value in vars(self).items():
39006
+ property_name = name[1:]
39007
+ if property_name in memeber_set:
39008
+ memeber_set.remove(property_name)
39009
+ if len(memeber_set) > 0:
39010
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
39011
+
39012
+
39013
+
39014
+ class OperateFlowRemarksResponse(AbstractModel):
39015
+ r"""OperateFlowRemarks返回参数结构体
39016
+
39017
+ """
39018
+
39019
+ def __init__(self):
39020
+ r"""
39021
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
39022
+ :type RequestId: str
39023
+ """
39024
+ self._RequestId = None
39025
+
39026
+ @property
39027
+ def RequestId(self):
39028
+ r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
39029
+ :rtype: str
39030
+ """
39031
+ return self._RequestId
39032
+
39033
+ @RequestId.setter
39034
+ def RequestId(self, RequestId):
39035
+ self._RequestId = RequestId
39036
+
39037
+
39038
+ def _deserialize(self, params):
39039
+ self._RequestId = params.get("RequestId")
39040
+
39041
+
38844
39042
  class OperateSealsRequest(AbstractModel):
38845
39043
  r"""OperateSeals请求参数结构体
38846
39044
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.82
3
+ Version: 3.1.86
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.82
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.86
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.86
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.82