tencentcloud-sdk-python 3.0.1258__py2.py3-none-any.whl → 3.0.1260__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/ca/v20230228/models.py +103 -0
  3. tencentcloud/cbs/v20170312/models.py +1 -1
  4. tencentcloud/cdb/v20170320/cdb_client.py +0 -25
  5. tencentcloud/cdb/v20170320/models.py +0 -111
  6. tencentcloud/cfs/v20190719/models.py +2 -1
  7. tencentcloud/cfw/v20190904/cfw_client.py +1 -3
  8. tencentcloud/cfw/v20190904/models.py +477 -877
  9. tencentcloud/clb/v20180317/models.py +1 -3
  10. tencentcloud/csip/v20221121/csip_client.py +1 -1
  11. tencentcloud/csip/v20221121/models.py +7 -709
  12. tencentcloud/cwp/v20180228/cwp_client.py +3 -1
  13. tencentcloud/cwp/v20180228/models.py +43 -70
  14. tencentcloud/dlc/v20210125/models.py +3 -3
  15. tencentcloud/dnspod/v20210323/dnspod_client.py +49 -0
  16. tencentcloud/dnspod/v20210323/models.py +356 -0
  17. tencentcloud/ecm/v20190719/models.py +1 -1
  18. tencentcloud/es/v20180416/models.py +13 -0
  19. tencentcloud/ess/v20201111/ess_client.py +25 -8
  20. tencentcloud/ess/v20201111/models.py +15 -4
  21. tencentcloud/essbasic/v20210526/essbasic_client.py +17 -14
  22. tencentcloud/essbasic/v20210526/models.py +9 -2
  23. tencentcloud/hunyuan/v20230901/models.py +13 -1
  24. tencentcloud/ioa/v20220601/models.py +8 -125
  25. tencentcloud/kms/v20190118/models.py +0 -25
  26. tencentcloud/lke/v20231130/lke_client.py +3 -1
  27. tencentcloud/mongodb/v20190725/models.py +4 -4
  28. tencentcloud/mps/v20190612/models.py +30 -1
  29. tencentcloud/mrs/v20200910/models.py +22 -0
  30. tencentcloud/ms/v20180408/models.py +99 -84
  31. tencentcloud/oceanus/v20190422/models.py +179 -0
  32. tencentcloud/ocr/v20181119/models.py +165 -1
  33. tencentcloud/ocr/v20181119/ocr_client.py +25 -0
  34. tencentcloud/redis/v20180412/models.py +18 -18
  35. tencentcloud/redis/v20180412/redis_client.py +2 -0
  36. tencentcloud/scf/v20180416/models.py +1 -1
  37. tencentcloud/sms/v20190711/errorcodes.py +1 -1
  38. tencentcloud/sms/v20210111/errorcodes.py +1 -1
  39. tencentcloud/tcss/v20201101/models.py +0 -13
  40. tencentcloud/tdmq/v20200217/models.py +1 -1
  41. tencentcloud/tem/v20210701/models.py +1 -1
  42. tencentcloud/teo/v20220901/errorcodes.py +3 -0
  43. tencentcloud/teo/v20220901/models.py +3 -5
  44. tencentcloud/trtc/v20190722/models.py +0 -31
  45. tencentcloud/trtc/v20190722/trtc_client.py +0 -25
  46. tencentcloud/waf/v20180125/models.py +453 -1049
  47. tencentcloud/waf/v20180125/waf_client.py +23 -75
  48. {tencentcloud_sdk_python-3.0.1258.dist-info → tencentcloud_sdk_python-3.0.1260.dist-info}/METADATA +1 -1
  49. {tencentcloud_sdk_python-3.0.1258.dist-info → tencentcloud_sdk_python-3.0.1260.dist-info}/RECORD +52 -52
  50. {tencentcloud_sdk_python-3.0.1258.dist-info → tencentcloud_sdk_python-3.0.1260.dist-info}/LICENSE +0 -0
  51. {tencentcloud_sdk_python-3.0.1258.dist-info → tencentcloud_sdk_python-3.0.1260.dist-info}/WHEEL +0 -0
  52. {tencentcloud_sdk_python-3.0.1258.dist-info → tencentcloud_sdk_python-3.0.1260.dist-info}/top_level.txt +0 -0
@@ -2350,6 +2350,184 @@ class CreateSnapshotResponse(AbstractModel):
2350
2350
  self._RequestId = params.get("RequestId")
2351
2351
 
2352
2352
 
2353
+ class CreateTXTRecordRequest(AbstractModel):
2354
+ """CreateTXTRecord请求参数结构体
2355
+
2356
+ """
2357
+
2358
+ def __init__(self):
2359
+ r"""
2360
+ :param _Domain: 域名
2361
+ :type Domain: str
2362
+ :param _RecordLine: 记录线路,通过 API 记录线路获得,中文,比如:默认。
2363
+ :type RecordLine: str
2364
+ :param _Value: 记录值,如 IP : 200.200.200.200, CNAME : cname.dnspod.com., MX : mail.dnspod.com.。
2365
+ :type Value: str
2366
+ :param _DomainId: 域名 ID 。参数 DomainId 优先级比参数 Domain 高,如果传递参数 DomainId 将忽略参数 Domain 。
2367
+ :type DomainId: int
2368
+ :param _SubDomain: 主机记录,如 www,如果不传,默认为 @。
2369
+ :type SubDomain: str
2370
+ :param _RecordLineId: 线路的 ID,通过 API 记录线路获得,英文字符串,比如:10=1。参数RecordLineId优先级高于RecordLine,如果同时传递二者,优先使用RecordLineId参数。
2371
+ :type RecordLineId: str
2372
+ :param _TTL: TTL,范围1-604800,不同套餐域名最小值不同。
2373
+ :type TTL: int
2374
+ :param _Status: 记录初始状态,取值范围为 ENABLE 和 DISABLE 。默认为 ENABLE ,如果传入 DISABLE,解析不会生效,也不会验证负载均衡的限制。
2375
+ :type Status: str
2376
+ :param _Remark: 备注
2377
+ :type Remark: str
2378
+ :param _GroupId: 记录分组 Id。可以通过接口 DescribeRecordGroupList 接口 GroupId 字段获取。
2379
+ :type GroupId: int
2380
+ """
2381
+ self._Domain = None
2382
+ self._RecordLine = None
2383
+ self._Value = None
2384
+ self._DomainId = None
2385
+ self._SubDomain = None
2386
+ self._RecordLineId = None
2387
+ self._TTL = None
2388
+ self._Status = None
2389
+ self._Remark = None
2390
+ self._GroupId = None
2391
+
2392
+ @property
2393
+ def Domain(self):
2394
+ return self._Domain
2395
+
2396
+ @Domain.setter
2397
+ def Domain(self, Domain):
2398
+ self._Domain = Domain
2399
+
2400
+ @property
2401
+ def RecordLine(self):
2402
+ return self._RecordLine
2403
+
2404
+ @RecordLine.setter
2405
+ def RecordLine(self, RecordLine):
2406
+ self._RecordLine = RecordLine
2407
+
2408
+ @property
2409
+ def Value(self):
2410
+ return self._Value
2411
+
2412
+ @Value.setter
2413
+ def Value(self, Value):
2414
+ self._Value = Value
2415
+
2416
+ @property
2417
+ def DomainId(self):
2418
+ return self._DomainId
2419
+
2420
+ @DomainId.setter
2421
+ def DomainId(self, DomainId):
2422
+ self._DomainId = DomainId
2423
+
2424
+ @property
2425
+ def SubDomain(self):
2426
+ return self._SubDomain
2427
+
2428
+ @SubDomain.setter
2429
+ def SubDomain(self, SubDomain):
2430
+ self._SubDomain = SubDomain
2431
+
2432
+ @property
2433
+ def RecordLineId(self):
2434
+ return self._RecordLineId
2435
+
2436
+ @RecordLineId.setter
2437
+ def RecordLineId(self, RecordLineId):
2438
+ self._RecordLineId = RecordLineId
2439
+
2440
+ @property
2441
+ def TTL(self):
2442
+ return self._TTL
2443
+
2444
+ @TTL.setter
2445
+ def TTL(self, TTL):
2446
+ self._TTL = TTL
2447
+
2448
+ @property
2449
+ def Status(self):
2450
+ return self._Status
2451
+
2452
+ @Status.setter
2453
+ def Status(self, Status):
2454
+ self._Status = Status
2455
+
2456
+ @property
2457
+ def Remark(self):
2458
+ return self._Remark
2459
+
2460
+ @Remark.setter
2461
+ def Remark(self, Remark):
2462
+ self._Remark = Remark
2463
+
2464
+ @property
2465
+ def GroupId(self):
2466
+ return self._GroupId
2467
+
2468
+ @GroupId.setter
2469
+ def GroupId(self, GroupId):
2470
+ self._GroupId = GroupId
2471
+
2472
+
2473
+ def _deserialize(self, params):
2474
+ self._Domain = params.get("Domain")
2475
+ self._RecordLine = params.get("RecordLine")
2476
+ self._Value = params.get("Value")
2477
+ self._DomainId = params.get("DomainId")
2478
+ self._SubDomain = params.get("SubDomain")
2479
+ self._RecordLineId = params.get("RecordLineId")
2480
+ self._TTL = params.get("TTL")
2481
+ self._Status = params.get("Status")
2482
+ self._Remark = params.get("Remark")
2483
+ self._GroupId = params.get("GroupId")
2484
+ memeber_set = set(params.keys())
2485
+ for name, value in vars(self).items():
2486
+ property_name = name[1:]
2487
+ if property_name in memeber_set:
2488
+ memeber_set.remove(property_name)
2489
+ if len(memeber_set) > 0:
2490
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
2491
+
2492
+
2493
+
2494
+ class CreateTXTRecordResponse(AbstractModel):
2495
+ """CreateTXTRecord返回参数结构体
2496
+
2497
+ """
2498
+
2499
+ def __init__(self):
2500
+ r"""
2501
+ :param _RecordId: 记录ID
2502
+ :type RecordId: int
2503
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2504
+ :type RequestId: str
2505
+ """
2506
+ self._RecordId = None
2507
+ self._RequestId = None
2508
+
2509
+ @property
2510
+ def RecordId(self):
2511
+ return self._RecordId
2512
+
2513
+ @RecordId.setter
2514
+ def RecordId(self, RecordId):
2515
+ self._RecordId = RecordId
2516
+
2517
+ @property
2518
+ def RequestId(self):
2519
+ return self._RequestId
2520
+
2521
+ @RequestId.setter
2522
+ def RequestId(self, RequestId):
2523
+ self._RequestId = RequestId
2524
+
2525
+
2526
+ def _deserialize(self, params):
2527
+ self._RecordId = params.get("RecordId")
2528
+ self._RequestId = params.get("RequestId")
2529
+
2530
+
2353
2531
  class CustomLineInfo(AbstractModel):
2354
2532
  """自定义线路详情
2355
2533
 
@@ -11278,6 +11456,184 @@ class ModifySubdomainStatusResponse(AbstractModel):
11278
11456
  self._RequestId = params.get("RequestId")
11279
11457
 
11280
11458
 
11459
+ class ModifyTXTRecordRequest(AbstractModel):
11460
+ """ModifyTXTRecord请求参数结构体
11461
+
11462
+ """
11463
+
11464
+ def __init__(self):
11465
+ r"""
11466
+ :param _Domain: 域名
11467
+ :type Domain: str
11468
+ :param _RecordLine: 记录线路,通过 API 记录线路获得,中文,比如:默认。
11469
+ :type RecordLine: str
11470
+ :param _Value: 记录值,如 IP : 200.200.200.200, CNAME : cname.dnspod.com., MX : mail.dnspod.com.。
11471
+ :type Value: str
11472
+ :param _RecordId: 记录 ID 。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId
11473
+ :type RecordId: int
11474
+ :param _DomainId: 域名 ID 。参数 DomainId 优先级比参数 Domain 高,如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId
11475
+ :type DomainId: int
11476
+ :param _SubDomain: 主机记录,如 www,如果不传,默认为 @。
11477
+ :type SubDomain: str
11478
+ :param _RecordLineId: 线路的 ID,通过 API 记录线路获得,英文字符串,比如:10=1。参数RecordLineId优先级高于RecordLine,如果同时传递二者,优先使用RecordLineId参数。
11479
+ :type RecordLineId: str
11480
+ :param _TTL: TTL,范围1-604800,不同等级域名最小值不同。
11481
+ :type TTL: int
11482
+ :param _Status: 记录初始状态,取值范围为 ENABLE 和 DISABLE 。默认为 ENABLE ,如果传入 DISABLE,解析不会生效,也不会验证负载均衡的限制。
11483
+ :type Status: str
11484
+ :param _Remark: 记录的备注信息。传空删除备注。
11485
+ :type Remark: str
11486
+ """
11487
+ self._Domain = None
11488
+ self._RecordLine = None
11489
+ self._Value = None
11490
+ self._RecordId = None
11491
+ self._DomainId = None
11492
+ self._SubDomain = None
11493
+ self._RecordLineId = None
11494
+ self._TTL = None
11495
+ self._Status = None
11496
+ self._Remark = None
11497
+
11498
+ @property
11499
+ def Domain(self):
11500
+ return self._Domain
11501
+
11502
+ @Domain.setter
11503
+ def Domain(self, Domain):
11504
+ self._Domain = Domain
11505
+
11506
+ @property
11507
+ def RecordLine(self):
11508
+ return self._RecordLine
11509
+
11510
+ @RecordLine.setter
11511
+ def RecordLine(self, RecordLine):
11512
+ self._RecordLine = RecordLine
11513
+
11514
+ @property
11515
+ def Value(self):
11516
+ return self._Value
11517
+
11518
+ @Value.setter
11519
+ def Value(self, Value):
11520
+ self._Value = Value
11521
+
11522
+ @property
11523
+ def RecordId(self):
11524
+ return self._RecordId
11525
+
11526
+ @RecordId.setter
11527
+ def RecordId(self, RecordId):
11528
+ self._RecordId = RecordId
11529
+
11530
+ @property
11531
+ def DomainId(self):
11532
+ return self._DomainId
11533
+
11534
+ @DomainId.setter
11535
+ def DomainId(self, DomainId):
11536
+ self._DomainId = DomainId
11537
+
11538
+ @property
11539
+ def SubDomain(self):
11540
+ return self._SubDomain
11541
+
11542
+ @SubDomain.setter
11543
+ def SubDomain(self, SubDomain):
11544
+ self._SubDomain = SubDomain
11545
+
11546
+ @property
11547
+ def RecordLineId(self):
11548
+ return self._RecordLineId
11549
+
11550
+ @RecordLineId.setter
11551
+ def RecordLineId(self, RecordLineId):
11552
+ self._RecordLineId = RecordLineId
11553
+
11554
+ @property
11555
+ def TTL(self):
11556
+ return self._TTL
11557
+
11558
+ @TTL.setter
11559
+ def TTL(self, TTL):
11560
+ self._TTL = TTL
11561
+
11562
+ @property
11563
+ def Status(self):
11564
+ return self._Status
11565
+
11566
+ @Status.setter
11567
+ def Status(self, Status):
11568
+ self._Status = Status
11569
+
11570
+ @property
11571
+ def Remark(self):
11572
+ return self._Remark
11573
+
11574
+ @Remark.setter
11575
+ def Remark(self, Remark):
11576
+ self._Remark = Remark
11577
+
11578
+
11579
+ def _deserialize(self, params):
11580
+ self._Domain = params.get("Domain")
11581
+ self._RecordLine = params.get("RecordLine")
11582
+ self._Value = params.get("Value")
11583
+ self._RecordId = params.get("RecordId")
11584
+ self._DomainId = params.get("DomainId")
11585
+ self._SubDomain = params.get("SubDomain")
11586
+ self._RecordLineId = params.get("RecordLineId")
11587
+ self._TTL = params.get("TTL")
11588
+ self._Status = params.get("Status")
11589
+ self._Remark = params.get("Remark")
11590
+ memeber_set = set(params.keys())
11591
+ for name, value in vars(self).items():
11592
+ property_name = name[1:]
11593
+ if property_name in memeber_set:
11594
+ memeber_set.remove(property_name)
11595
+ if len(memeber_set) > 0:
11596
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
11597
+
11598
+
11599
+
11600
+ class ModifyTXTRecordResponse(AbstractModel):
11601
+ """ModifyTXTRecord返回参数结构体
11602
+
11603
+ """
11604
+
11605
+ def __init__(self):
11606
+ r"""
11607
+ :param _RecordId: 记录ID
11608
+ :type RecordId: int
11609
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11610
+ :type RequestId: str
11611
+ """
11612
+ self._RecordId = None
11613
+ self._RequestId = None
11614
+
11615
+ @property
11616
+ def RecordId(self):
11617
+ return self._RecordId
11618
+
11619
+ @RecordId.setter
11620
+ def RecordId(self, RecordId):
11621
+ self._RecordId = RecordId
11622
+
11623
+ @property
11624
+ def RequestId(self):
11625
+ return self._RequestId
11626
+
11627
+ @RequestId.setter
11628
+ def RequestId(self, RequestId):
11629
+ self._RequestId = RequestId
11630
+
11631
+
11632
+ def _deserialize(self, params):
11633
+ self._RecordId = params.get("RecordId")
11634
+ self._RequestId = params.get("RequestId")
11635
+
11636
+
11281
11637
  class ModifyVasAutoRenewStatusRequest(AbstractModel):
11282
11638
  """ModifyVasAutoRenewStatus请求参数结构体
11283
11639
 
@@ -2973,7 +2973,7 @@ class CreateLoadBalancerRequest(AbstractModel):
2973
2973
  :type SecurityGroups: list of str
2974
2974
  :param _AddressIPVersion: 仅适用于公网负载均衡。IP版本,可取值:IPV4、IPv6FullChain,默认值 IPV4。说明:取值为IPv6FullChain,表示为IPv6版本。
2975
2975
  :type AddressIPVersion: str
2976
- :param _SubnetId: 在购买IPV6负载均衡实例的情况下,必须指定子网 ID, 此参数必填。
2976
+ :param _SubnetId: 在购买IPV6负载均衡实例的情况下,必须指定子网 ID, 此参数必填;IPv4实例不支持该参数。
2977
2977
  :type SubnetId: str
2978
2978
  """
2979
2979
  self._EcmRegion = None
@@ -13552,10 +13552,14 @@ class ServerlessIndexOptionsField(AbstractModel):
13552
13552
  :param _SinkCycleAge: 标准存储时长
13553
13553
  注意:此字段可能返回 null,表示取不到有效值。
13554
13554
  :type SinkCycleAge: str
13555
+ :param _StandardStorageAge: 标准存储时长
13556
+ 注意:此字段可能返回 null,表示取不到有效值。
13557
+ :type StandardStorageAge: str
13555
13558
  """
13556
13559
  self._ExpireMaxAge = None
13557
13560
  self._TimestampField = None
13558
13561
  self._SinkCycleAge = None
13562
+ self._StandardStorageAge = None
13559
13563
 
13560
13564
  @property
13561
13565
  def ExpireMaxAge(self):
@@ -13581,11 +13585,20 @@ class ServerlessIndexOptionsField(AbstractModel):
13581
13585
  def SinkCycleAge(self, SinkCycleAge):
13582
13586
  self._SinkCycleAge = SinkCycleAge
13583
13587
 
13588
+ @property
13589
+ def StandardStorageAge(self):
13590
+ return self._StandardStorageAge
13591
+
13592
+ @StandardStorageAge.setter
13593
+ def StandardStorageAge(self, StandardStorageAge):
13594
+ self._StandardStorageAge = StandardStorageAge
13595
+
13584
13596
 
13585
13597
  def _deserialize(self, params):
13586
13598
  self._ExpireMaxAge = params.get("ExpireMaxAge")
13587
13599
  self._TimestampField = params.get("TimestampField")
13588
13600
  self._SinkCycleAge = params.get("SinkCycleAge")
13601
+ self._StandardStorageAge = params.get("StandardStorageAge")
13589
13602
  memeber_set = set(params.keys())
13590
13603
  for name, value in vars(self).items():
13591
13604
  property_name = name[1:]
@@ -859,13 +859,25 @@ class EssClient(AbstractClient):
859
859
 
860
860
 
861
861
  def CreateFlowGroupByFiles(self, request):
862
- """此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。
862
+ """此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
863
863
 
864
- 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
864
+ - 该接口允许通过PDF资源ID一次性创建多个合同,这些合同被组织在一个合同组中。
865
+ - 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。
866
+ - 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。
865
867
 
866
- 注意事项:使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
868
+ <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
867
869
 
868
- 注:`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
870
+ ### 2. 适用场景
871
+
872
+ 该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
873
+
874
+
875
+ ### 3. 合同额度的扣减与返还
876
+ - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
877
+ - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
878
+ - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
879
+
880
+ ### 4.合同组暂不支持抄送功能
869
881
 
870
882
  :param request: Request instance for CreateFlowGroupByFiles.
871
883
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupByFilesRequest`
@@ -896,17 +908,17 @@ class EssClient(AbstractClient):
896
908
 
897
909
  <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
898
910
 
899
- ### 1. 适用场景
911
+ ### 2. 适用场景
900
912
 
901
913
  该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
902
914
 
903
915
 
904
- ### 2. 合同额度的扣减与返还
916
+ ### 3. 合同额度的扣减与返还
905
917
  - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
906
918
  - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
907
919
  - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
908
920
 
909
- ### 3.合同组暂不支持抄送功能
921
+ ### 4.合同组暂不支持抄送功能
910
922
 
911
923
  :param request: Request instance for CreateFlowGroupByTemplates.
912
924
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowGroupByTemplatesRequest`
@@ -2181,12 +2193,17 @@ class EssClient(AbstractClient):
2181
2193
  适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
2182
2194
 
2183
2195
 
2184
- **注**:用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
2196
+ ### 2. 确保合同的PDF已经合成后,再调用本接口。
2197
+
2198
+ 用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
2185
2199
 
2186
2200
  **第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
2187
2201
 
2188
2202
  **第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowBriefs)接口来主动检查合同的签署状态。请仅在确认合同状态为“签署完成”后,进行文件的下载操作。
2189
2203
 
2204
+ ### 3. 链接具有有效期限
2205
+ <font color="red"><b>生成的链接是有时间限制的,过期后将无法访问</b></font>。您可以在接口返回的信息中查看具体的过期时间。为避免错误,请确保在链接过期之前进行下载操作。
2206
+
2190
2207
  :param request: Request instance for DescribeFileUrls.
2191
2208
  :type request: :class:`tencentcloud.ess.v20201111.models.DescribeFileUrlsRequest`
2192
2209
  :rtype: :class:`tencentcloud.ess.v20201111.models.DescribeFileUrlsResponse`
@@ -3518,9 +3518,14 @@ class CreateBatchQuickSignUrlRequest(AbstractModel):
3518
3518
  :type SignTypeSelector: int
3519
3519
  :param _FlowBatchUrlInfo: 批量签署合同相关信息,指定合同和签署方的信息,用于补充动态签署人。
3520
3520
  :type FlowBatchUrlInfo: :class:`tencentcloud.ess.v20201111.models.FlowBatchUrlInfo`
3521
- :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>获取到当时的视频。
3521
+ :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签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
3522
+
3523
+ 注意:
3524
+ 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
3525
+ 2. 使用视频认证时,<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
3526
+ 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
3522
3527
  :type Intention: :class:`tencentcloud.ess.v20201111.models.Intention`
3523
- :param _CacheApproverInfo: 是否开启缓存签署人信息
3528
+ :param _CacheApproverInfo: 缓存签署人信息。在H5签署链接动态领取场景,首次填写后,选择缓存签署人信息,在下次签署人点击领取链接时,会自动将个人信息(姓名、身份证号、手机号)填入,否则需要每次手动填写。
3524
3529
  :type CacheApproverInfo: bool
3525
3530
  """
3526
3531
  self._FlowApproverInfo = None
@@ -5224,6 +5229,10 @@ class CreateFlowByFilesRequest(AbstractModel):
5224
5229
  :type Components: list of Component
5225
5230
  :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
5226
5231
 
5232
+ <b>注</b>
5233
+ 1. 抄送人名单中可以包括自然人以及本企业的员工。
5234
+ 2. 请确保抄送人列表中的成员不与任何签署人重复。
5235
+
5227
5236
  :type CcInfos: list of CcInfo
5228
5237
  :param _CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
5229
5238
  <ul><li> **0**:合同发起时通知(默认值)</li>
@@ -5897,10 +5906,8 @@ class CreateFlowGroupByFilesResponse(AbstractModel):
5897
5906
  def __init__(self):
5898
5907
  r"""
5899
5908
  :param _FlowGroupId: 合同(流程)组的合同组Id
5900
- 注意:此字段可能返回 null,表示取不到有效值。
5901
5909
  :type FlowGroupId: str
5902
5910
  :param _FlowIds: 合同(流程)组中子合同列表.
5903
- 注意:此字段可能返回 null,表示取不到有效值。
5904
5911
  :type FlowIds: list of str
5905
5912
  :param _Approvers: 合同组签署方信息。
5906
5913
  :type Approvers: list of FlowGroupApprovers
@@ -6718,6 +6725,10 @@ class CreateFlowRequest(AbstractModel):
6718
6725
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6719
6726
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6720
6727
  :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
6728
+
6729
+ <b>注</b>
6730
+ 1. 抄送人名单中可以包括自然人以及本企业的员工。
6731
+ 2. 请确保抄送人列表中的成员不与任何签署人重复。
6721
6732
  :type CcInfos: list of CcInfo
6722
6733
  :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
6723
6734
  <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
@@ -453,11 +453,11 @@ class EssbasicClient(AbstractClient):
453
453
  <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
454
454
 
455
455
 
456
- ### 1. 适用场景
456
+ ### 2. 适用场景
457
457
 
458
458
  该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
459
459
 
460
- ### 2. 发起方要求和签署方实名要求
460
+ ### 3. 发起方要求和签署方实名要求
461
461
  - **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。
462
462
  - **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。
463
463
 
@@ -499,18 +499,18 @@ class EssbasicClient(AbstractClient):
499
499
  </tbody>
500
500
  </table>
501
501
 
502
- ### 3. 签署方参数差异
502
+ ### 4. 签署方参数差异
503
503
  - 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。
504
504
 
505
- ### 4. 合同额度的扣减与返还
505
+ ### 5. 合同额度的扣减与返还
506
506
  - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
507
507
  - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
508
508
  - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
509
509
 
510
- ### 5. 静默(自动)签署的限制
510
+ ### 6. 静默(自动)签署的限制
511
511
  - 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color="red">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。
512
512
 
513
- ### 6.合同组暂不支持抄送功能
513
+ ### 7.合同组暂不支持抄送功能
514
514
 
515
515
  :param request: Request instance for ChannelCreateFlowGroupByFiles.
516
516
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowGroupByFilesRequest`
@@ -541,11 +541,11 @@ class EssbasicClient(AbstractClient):
541
541
 
542
542
  <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
543
543
 
544
- ### 1. 适用场景
544
+ ### 2. 适用场景
545
545
 
546
546
  该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
547
547
 
548
- ### 2. 发起方要求和签署方实名要求
548
+ ### 3. 发起方要求和签署方实名要求
549
549
  - **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。
550
550
  - **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。
551
551
 
@@ -586,18 +586,18 @@ class EssbasicClient(AbstractClient):
586
586
  </tbody>
587
587
  </table>
588
588
 
589
- ### 3. 签署方参数差异
589
+ ### 4. 签署方参数差异
590
590
  - 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。
591
591
 
592
- ### 4. 合同额度的扣减与返还
592
+ ### 5. 合同额度的扣减与返还
593
593
  - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
594
594
  - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
595
595
  - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
596
596
 
597
- ### 5. 静默(自动)签署的限制
597
+ ### 6. 静默(自动)签署的限制
598
598
  - 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color="red">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。
599
599
 
600
- ### 6.合同组暂不支持抄送功能
600
+ ### 7.合同组暂不支持抄送功能
601
601
 
602
602
  :param request: Request instance for ChannelCreateFlowGroupByTemplates.
603
603
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowGroupByTemplatesRequest`
@@ -2449,14 +2449,17 @@ class EssbasicClient(AbstractClient):
2449
2449
 
2450
2450
 
2451
2451
 
2452
- ### 1. 确保合同的PDF已经合成后,再调用本接口。
2452
+ ### 2. 确保合同的PDF已经合成后,再调用本接口。
2453
2453
  用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
2454
2454
 
2455
2455
  **第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
2456
2456
 
2457
2457
  **第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。
2458
2458
 
2459
- ### 2. 有两种开通下载权限的途径。
2459
+ ### 3. 链接具有有效期限
2460
+ <font color="red"><b>生成的链接是有时间限制的,过期后将无法访问</b></font>。您可以在接口返回的信息中查看具体的过期时间。为避免错误,请确保在链接过期之前进行下载操作。
2461
+
2462
+ ### 4. 有两种开通下载权限的途径。
2460
2463
 
2461
2464
  **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图。
2462
2465
  授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>