tencentcloud-sdk-python-essbasic 3.0.1263__tar.gz → 3.0.1268__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 (20) hide show
  1. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/PKG-INFO +3 -3
  2. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/setup.cfg +0 -1
  3. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/setup.py +1 -1
  4. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/__init__.py +1 -1
  5. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20210526/essbasic_client.py +37 -12
  6. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20210526/models.py +115 -48
  7. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +3 -3
  8. tencentcloud-sdk-python-essbasic-3.0.1268/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  9. tencentcloud-sdk-python-essbasic-3.0.1263/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  10. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/README.rst +0 -0
  11. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/__init__.py +0 -0
  12. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  13. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  15. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-essbasic-3.0.1263 → tencentcloud-sdk-python-essbasic-3.0.1268}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
@@ -1,10 +1,10 @@
1
- Metadata-Version: 1.1
1
+ Metadata-Version: 1.2
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1263
3
+ Version: 3.0.1268
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
7
- Author-email: tencentcloudapi@tencent.com
7
+ Maintainer-email: tencentcloudapi@tencent.com
8
8
  License: Apache License 2.0
9
9
  Description: ============================
10
10
  Tencent Cloud SDK for Python
@@ -4,5 +4,4 @@ universal = 1
4
4
  [egg_info]
5
5
  tag_build =
6
6
  tag_date = 0
7
- tag_svn_revision = 0
8
7
 
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-essbasic',
11
- install_requires=["tencentcloud-sdk-python-common==3.0.1263"],
11
+ install_requires=["tencentcloud-sdk-python-common==3.0.1268"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Essbasic SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1263'
17
+ __version__ = '3.0.1268'
@@ -181,11 +181,10 @@ class EssbasicClient(AbstractClient):
181
181
 
182
182
 
183
183
  def ChannelCreateBatchQuickSignUrl(self, request):
184
- """该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
184
+ """该接口用于发起合同后,生成个人/企业用户的批量待办链接。
185
185
  **注意:**
186
- 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)
187
- 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
188
- 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
186
+ 1. 该接口可生成签署人的批量、合同组签署/查看链接
187
+ 2. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接
189
188
  4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
190
189
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
191
190
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
@@ -1236,12 +1235,32 @@ class EssbasicClient(AbstractClient):
1236
1235
 
1237
1236
 
1238
1237
  def ChannelDescribeFlowComponents(self, request):
1239
- """用于获取合同中填写控件填写状态和填写的内容。
1238
+ """您可以通过合同流程ID查询相关的<font color="red"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态(是否已填写)以及具体的填写内容。
1239
+
1240
+ 无论是<font color="red"><b>发起方还是签署方</b></font>填写的控件,均包含在查询结果中。
1241
+
1242
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
1243
+ ### 2. 那些控件会出现在结果里边?
1244
+ **A.不返回的控件类型:**
1245
+ - 动态表格
1246
+ - 附件控件
1247
+ - 水印控件
1248
+
1249
+ **B.返回的控件类型:**
1250
+ - 单行文本
1251
+ - 多行文本
1252
+ - 勾选框控件
1253
+ - 数字控件
1254
+ - 日期控件
1255
+ - 图片控件(图片下载地址)
1256
+ - 邮箱控件
1257
+ - 地址控件
1258
+ - 学历控件
1259
+ - 性别控件
1260
+ - 省市区控件
1261
+
1262
+ ### 3.怎么授权?
1240
1263
 
1241
- **注意**: `附件控件不会出现在结果列表中`
1242
-
1243
-
1244
- **授权**:
1245
1264
  此接口需要授权, 有两种开通权限的途径
1246
1265
 
1247
1266
  **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
@@ -2061,14 +2080,19 @@ class EssbasicClient(AbstractClient):
2061
2080
 
2062
2081
 
2063
2082
  def CreatePartnerAutoSignAuthUrl(self, request):
2064
- """创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。
2065
- 该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
2083
+ """创建一个用于他方自动签授权的链接(可选择他方授权或我方授权)。通过这个链接,合作方企业可以直接进入小程序,进行自动签授权操作。
2066
2084
 
2085
+ 如果授权企业尚未开通企业自动签功能,该链接还将引导他们首先开通本企业的自动签服务
2067
2086
 
2068
2087
 
2069
2088
  注:
2070
2089
  1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
2071
2090
  2. 已经在授权中或者授权成功的企业,无法重复授权
2091
+ 3. 授权企业和被授权企业必须都是已认证企业
2092
+ 4. <font color='red'>需要授权企业或被授权企业的超管或者法人打开链接</font>走开通逻辑。
2093
+
2094
+ **该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权**
2095
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/091823fd4f02af7dda416fa10ca65f2d.png)
2072
2096
 
2073
2097
  :param request: Request instance for CreatePartnerAutoSignAuthUrl.
2074
2098
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreatePartnerAutoSignAuthUrlRequest`
@@ -2548,7 +2572,8 @@ class EssbasicClient(AbstractClient):
2548
2572
 
2549
2573
  def DescribeUsage(self, request):
2550
2574
  """此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
2551
- <font color="red">此接口即将下线, 请使用新接口[查询渠道计费消耗情况](https://qian.tencent.com/developers/partnerApis/fee/ChannelDescribeBillUsageDetail)</font>
2575
+
2576
+ <font color="red">此接口即将下线, 请使用新接口</font> [查询渠道计费消耗情况](https://qian.tencent.com/developers/partnerApis/fee/ChannelDescribeBillUsageDetail)
2552
2577
 
2553
2578
  注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
2554
2579
 
@@ -2360,10 +2360,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2360
2360
  def __init__(self):
2361
2361
  r"""
2362
2362
  :param _FlowApproverInfo: 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
2363
+ <ul>
2364
+ <li>若为个人参与方:ApproverType:"PERSON"</li>
2365
+ <li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>
2366
+ </ul>
2367
+
2363
2368
  注:
2364
- `1. ApproverType目前只支持个人类型的签署人。`
2365
- `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
2366
- `3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
2369
+ `1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
2370
+ `2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
2367
2371
  :type FlowApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
2368
2372
  :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2369
2373
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
@@ -2384,7 +2388,9 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2384
2388
  注:
2385
2389
  <ul><li>默认情况下,签名类型为手写签名</li>
2386
2390
  <li>您可以传递多种值,表示可用多种签名类型。</li>
2387
- <li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul>
2391
+ <li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
2392
+ <li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>
2393
+ </ul>
2388
2394
  :type SignatureTypes: list of int
2389
2395
  :param _ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值:
2390
2396
  <ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
@@ -2401,10 +2407,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2401
2407
  `不指定该值时,默认为签署方自行选择。`
2402
2408
  :type SignTypeSelector: int
2403
2409
  :param _FlowBatchUrlInfo: 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
2410
+
2411
+ 注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
2404
2412
  :type FlowBatchUrlInfo: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
2405
2413
  :param _Intention: <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。 注意: 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
2406
2414
  :type Intention: :class:`tencentcloud.essbasic.v20210526.models.Intention`
2407
2415
  :param _CacheApproverInfo: 缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
2416
+
2417
+ 注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
2408
2418
  :type CacheApproverInfo: bool
2409
2419
  """
2410
2420
  self._FlowApproverInfo = None
@@ -2422,10 +2432,14 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2422
2432
  @property
2423
2433
  def FlowApproverInfo(self):
2424
2434
  """批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
2435
+ <ul>
2436
+ <li>若为个人参与方:ApproverType:"PERSON"</li>
2437
+ <li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>
2438
+ </ul>
2439
+
2425
2440
  注:
2426
- `1. ApproverType目前只支持个人类型的签署人。`
2427
- `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
2428
- `3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
2441
+ `1. 暂不支持签署人拖动签署控件功能,以及签批控件。`
2442
+ `2. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
2429
2443
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowApproverInfo`
2430
2444
  """
2431
2445
  return self._FlowApproverInfo
@@ -2491,7 +2505,9 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2491
2505
  注:
2492
2506
  <ul><li>默认情况下,签名类型为手写签名</li>
2493
2507
  <li>您可以传递多种值,表示可用多种签名类型。</li>
2494
- <li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul>
2508
+ <li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>
2509
+ <li>若签署方为企业员工,此参数无效,签名方式将以合同中为准。</li>
2510
+ </ul>
2495
2511
  :rtype: list of int
2496
2512
  """
2497
2513
  return self._SignatureTypes
@@ -2535,6 +2551,8 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2535
2551
  @property
2536
2552
  def FlowBatchUrlInfo(self):
2537
2553
  """批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
2554
+
2555
+ 注: `若签署方为企业员工,暂不支持通过H5端进行动态签署人的补充`
2538
2556
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.FlowBatchUrlInfo`
2539
2557
  """
2540
2558
  return self._FlowBatchUrlInfo
@@ -2557,6 +2575,8 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
2557
2575
  @property
2558
2576
  def CacheApproverInfo(self):
2559
2577
  """缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
2578
+
2579
+ 注: `若参与方为企业员工时,暂不支持对参与方信息进行缓存`
2560
2580
  :rtype: bool
2561
2581
  """
2562
2582
  return self._CacheApproverInfo
@@ -5403,6 +5423,8 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
5403
5423
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
5404
5424
  :param _ForbidPersonalMultipleSign: 禁止个人用户重复签署,默认不禁止,即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同,请传入true。
5405
5425
  :type ForbidPersonalMultipleSign: bool
5426
+ :param _FlowNameAppendScannerInfo: 合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
5427
+ :type FlowNameAppendScannerInfo: bool
5406
5428
  """
5407
5429
  self._Agent = None
5408
5430
  self._TemplateId = None
@@ -5416,6 +5438,7 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
5416
5438
  self._ApproverRestrictions = None
5417
5439
  self._Operator = None
5418
5440
  self._ForbidPersonalMultipleSign = None
5441
+ self._FlowNameAppendScannerInfo = None
5419
5442
 
5420
5443
  @property
5421
5444
  def Agent(self):
@@ -5571,6 +5594,17 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
5571
5594
  def ForbidPersonalMultipleSign(self, ForbidPersonalMultipleSign):
5572
5595
  self._ForbidPersonalMultipleSign = ForbidPersonalMultipleSign
5573
5596
 
5597
+ @property
5598
+ def FlowNameAppendScannerInfo(self):
5599
+ """合同流程名称是否应包含扫码签署人的信息,且遵循特定格式(flowname-姓名-手机号后四位)。 例如,通过参数FlowName设定的扫码发起合同名称为“员工入职合同”,当扫码人张三(手机号18800009527)扫码签署时,合同名称将自动生成为“员工入职合同-张三-9527”。
5600
+ :rtype: bool
5601
+ """
5602
+ return self._FlowNameAppendScannerInfo
5603
+
5604
+ @FlowNameAppendScannerInfo.setter
5605
+ def FlowNameAppendScannerInfo(self, FlowNameAppendScannerInfo):
5606
+ self._FlowNameAppendScannerInfo = FlowNameAppendScannerInfo
5607
+
5574
5608
 
5575
5609
  def _deserialize(self, params):
5576
5610
  if params.get("Agent") is not None:
@@ -5601,6 +5635,7 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
5601
5635
  self._Operator = UserInfo()
5602
5636
  self._Operator._deserialize(params.get("Operator"))
5603
5637
  self._ForbidPersonalMultipleSign = params.get("ForbidPersonalMultipleSign")
5638
+ self._FlowNameAppendScannerInfo = params.get("FlowNameAppendScannerInfo")
5604
5639
  memeber_set = set(params.keys())
5605
5640
  for name, value in vars(self).items():
5606
5641
  property_name = name[1:]
@@ -6560,14 +6595,13 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
6560
6595
  :type NeedRelievedFlowId: str
6561
6596
  :param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
6562
6597
  :type ReliveInfo: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
6563
- :param _ReleasedApprovers: 指定解除协议的签署人,如不指定,则默认使用原流程的签署人。 <br/>
6598
+ :param _ReleasedApprovers: 替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
6564
6599
  如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
6565
6600
 
6566
- 注意:
6567
- <ul>
6568
- <li>只能更换自己企业的签署人,不支持更换个人类型或者其他企业的签署人</li>
6569
- <li>可以不指定替换签署人,使用原流程的签署人</li>
6570
- </ul>
6601
+ 注:
6602
+ 1. 支持更换企业的签署人,不支持更换个人类型的签署人。
6603
+ 2. 己方企业支持自动签署,他方企业不支持自动签署。
6604
+ 3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。
6571
6605
  :type ReleasedApprovers: list of ReleasedApprover
6572
6606
  :param _CallbackUrl: 签署完回调url,最大长度1000个字符
6573
6607
  :type CallbackUrl: str
@@ -6641,14 +6675,13 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
6641
6675
 
6642
6676
  @property
6643
6677
  def ReleasedApprovers(self):
6644
- """指定解除协议的签署人,如不指定,则默认使用原流程的签署人。 <br/>
6678
+ """替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
6645
6679
  如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
6646
6680
 
6647
- 注意:
6648
- <ul>
6649
- <li>只能更换自己企业的签署人,不支持更换个人类型或者其他企业的签署人</li>
6650
- <li>可以不指定替换签署人,使用原流程的签署人</li>
6651
- </ul>
6681
+ 注:
6682
+ 1. 支持更换企业的签署人,不支持更换个人类型的签署人。
6683
+ 2. 己方企业支持自动签署,他方企业不支持自动签署。
6684
+ 3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。
6652
6685
  :rtype: list of ReleasedApprover
6653
6686
  """
6654
6687
  return self._ReleasedApprovers
@@ -11820,6 +11853,10 @@ class Component(AbstractModel):
11820
11853
  <li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>
11821
11854
  <b>参数样例</b>:`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
11822
11855
 
11856
+ <font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
11857
+ <ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>
11858
+ <b>参数样例</b>:`{"Opacity":0.7}`
11859
+
11823
11860
  <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
11824
11861
  <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
11825
11862
  场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
@@ -12166,6 +12203,10 @@ class Component(AbstractModel):
12166
12203
  <li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>
12167
12204
  <b>参数样例</b>:`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
12168
12205
 
12206
+ <font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
12207
+ <ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>
12208
+ <b>参数样例</b>:`{"Opacity":0.7}`
12209
+
12169
12210
  <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
12170
12211
  <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
12171
12212
  场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
@@ -14998,26 +15039,39 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
14998
15039
  </ul>
14999
15040
  第三方平台子客企业和员工必须已经经过实名认证
15000
15041
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
15001
- :param _AuthorizedOrganizationId: 被授企业id,和AuthorizedOrganizationName二选一,不能同时为空
15042
+ :param _AuthorizedOrganizationId: 被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。
15043
+
15002
15044
  注:`被授权企业必须和当前企业在同一应用号下`
15003
15045
  :type AuthorizedOrganizationId: str
15004
- :param _AuthorizedOrganizationName: 被授权企业名,和AuthorizedOrganizationId二选一,不能同时为空
15005
- 注:`被授权企业必须和当前企业在同一应用号下`
15046
+ :param _AuthorizedOrganizationName: 被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
15047
+
15048
+ 注:
15049
+ 1. 如果名称中包含英文括号(),请使用中文括号()代替。
15050
+ 2. 被授权企业必须和当前企业在同一应用号下
15006
15051
  :type AuthorizedOrganizationName: str
15007
- :param _PlatformAppAuthorization: 是否给平台应用授权:
15008
- - true: 是(无需设置AuthorizedOrganizationId和AuthorizedOrganizationName)
15009
- - false: 否(默认)
15010
- 注:该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”,请联系运营经理开通
15052
+ :param _PlatformAppAuthorization: 是否给平台应用授权
15011
15053
 
15054
+ <ul>
15055
+ <li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>
15056
+ <li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>
15057
+ </ul>
15058
+
15059
+ 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。
15012
15060
  :type PlatformAppAuthorization: bool
15013
- :param _SealTypes: 指定印章类型,指定后只能选择该类型的印章进行授权
15014
- 支持以下印章类型:
15015
- - OFFICIAL : 企业公章
15016
- - CONTRACT : 合同专用章
15017
- - FINANCE : 财务专用章
15018
- - PERSONNEL : 人事专用章
15061
+ :param _SealTypes: 在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:
15062
+
15063
+ <ul>
15064
+ <li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>
15065
+ <li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>
15066
+ <li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>
15067
+ <li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>
15068
+ </ul>
15019
15069
  :type SealTypes: list of str
15020
- :param _AuthToMe: 他方授权给我方:- false:我方授权他方,AuthorizedOrganizationName代表【被授权方】企业名称- true:他方授权我方,AuthorizedOrganizationName代表【授权方】企业名称
15070
+ :param _AuthToMe: 在处理授权关系时,授权的方向
15071
+ <ul>
15072
+ <li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
15073
+ <li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
15074
+ </ul>
15021
15075
  :type AuthToMe: bool
15022
15076
  """
15023
15077
  self._Agent = None
@@ -15048,7 +15102,8 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
15048
15102
 
15049
15103
  @property
15050
15104
  def AuthorizedOrganizationId(self):
15051
- """被授企业id,和AuthorizedOrganizationName二选一,不能同时为空
15105
+ """被授企业id/授权方企业id(即OrganizationId),如果是企业之间授权和AuthorizedOrganizationName二选一传入。
15106
+
15052
15107
  注:`被授权企业必须和当前企业在同一应用号下`
15053
15108
  :rtype: str
15054
15109
  """
@@ -15060,8 +15115,11 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
15060
15115
 
15061
15116
  @property
15062
15117
  def AuthorizedOrganizationName(self):
15063
- """被授权企业名,和AuthorizedOrganizationId二选一,不能同时为空
15064
- 注:`被授权企业必须和当前企业在同一应用号下`
15118
+ """被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。
15119
+
15120
+ 注:
15121
+ 1. 如果名称中包含英文括号(),请使用中文括号()代替。
15122
+ 2. 被授权企业必须和当前企业在同一应用号下
15065
15123
  :rtype: str
15066
15124
  """
15067
15125
  return self._AuthorizedOrganizationName
@@ -15072,11 +15130,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
15072
15130
 
15073
15131
  @property
15074
15132
  def PlatformAppAuthorization(self):
15075
- """是否给平台应用授权:
15076
- - true: 是(无需设置AuthorizedOrganizationId和AuthorizedOrganizationName)
15077
- - false: 否(默认)
15078
- 注:该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”,请联系运营经理开通
15133
+ """是否给平台应用授权
15134
+
15135
+ <ul>
15136
+ <li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li>
15137
+ <li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li>
15138
+ </ul>
15079
15139
 
15140
+ 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。
15080
15141
  :rtype: bool
15081
15142
  """
15082
15143
  return self._PlatformAppAuthorization
@@ -15087,12 +15148,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
15087
15148
 
15088
15149
  @property
15089
15150
  def SealTypes(self):
15090
- """指定印章类型,指定后只能选择该类型的印章进行授权
15091
- 支持以下印章类型:
15092
- - OFFICIAL : 企业公章
15093
- - CONTRACT : 合同专用章
15094
- - FINANCE : 财务专用章
15095
- - PERSONNEL : 人事专用章
15151
+ """在设置印章授权时,可以指定特定的印章类型,以确保在授权过程中只使用相应类型的印章。支持的印章类型包括:
15152
+
15153
+ <ul>
15154
+ <li><strong>OFFICIAL</strong>:企业公章,用于代表企业对外的正式文件和重要事务的认证。</li>
15155
+ <li><strong>CONTRACT</strong>:合同专用章,专门用于签署各类合同。</li>
15156
+ <li><strong>FINANCE</strong>:财务专用章,用于企业的财务相关文件,如发票、收据等财务凭证的认证。</li>
15157
+ <li><strong>PERSONNEL</strong>:人事专用章,用于人事管理相关文件,如劳动合同、人事任命等。</li>
15158
+ </ul>
15096
15159
  :rtype: list of str
15097
15160
  """
15098
15161
  return self._SealTypes
@@ -15103,7 +15166,11 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
15103
15166
 
15104
15167
  @property
15105
15168
  def AuthToMe(self):
15106
- """他方授权给我方:- false:我方授权他方,AuthorizedOrganizationName代表【被授权方】企业名称- true:他方授权我方,AuthorizedOrganizationName代表【授权方】企业名称
15169
+ """在处理授权关系时,授权的方向
15170
+ <ul>
15171
+ <li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li>
15172
+ <li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li>
15173
+ </ul>
15107
15174
  :rtype: bool
15108
15175
  """
15109
15176
  return self._AuthToMe
@@ -1,10 +1,10 @@
1
- Metadata-Version: 1.1
1
+ Metadata-Version: 1.2
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1263
3
+ Version: 3.0.1268
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
7
- Author-email: tencentcloudapi@tencent.com
7
+ Maintainer-email: tencentcloudapi@tencent.com
8
8
  License: Apache License 2.0
9
9
  Description: ============================
10
10
  Tencent Cloud SDK for Python
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common==3.0.1268
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common==3.0.1263