tencentcloud-sdk-python 3.0.974__py2.py3-none-any.whl → 3.0.976__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.

Potentially problematic release.


This version of tencentcloud-sdk-python might be problematic. Click here for more details.

Files changed (54) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/cbs/v20170312/cbs_client.py +2 -2
  3. tencentcloud/ccc/v20200210/ccc_client.py +1 -1
  4. tencentcloud/ccc/v20200210/models.py +67 -1
  5. tencentcloud/cdb/v20170320/errorcodes.py +6 -0
  6. tencentcloud/cdwch/v20200915/models.py +201 -0
  7. tencentcloud/ckafka/v20190819/models.py +2 -2
  8. tencentcloud/clb/v20180317/models.py +52 -0
  9. tencentcloud/cls/v20201016/models.py +26 -0
  10. tencentcloud/cvm/v20170312/cvm_client.py +1 -0
  11. tencentcloud/cvm/v20170312/models.py +1 -13
  12. tencentcloud/cynosdb/v20190107/models.py +9 -6
  13. tencentcloud/dnspod/v20210323/errorcodes.py +7 -7
  14. tencentcloud/dnspod/v20210323/models.py +1 -1
  15. tencentcloud/ecm/v20190719/models.py +12 -0
  16. tencentcloud/eis/v20210601/errorcodes.py +3 -0
  17. tencentcloud/emr/v20190103/errorcodes.py +3 -0
  18. tencentcloud/ess/v20201111/ess_client.py +46 -24
  19. tencentcloud/ess/v20201111/models.py +274 -171
  20. tencentcloud/essbasic/v20210526/essbasic_client.py +7 -0
  21. tencentcloud/essbasic/v20210526/models.py +22 -15
  22. tencentcloud/faceid/v20180301/models.py +17 -1
  23. tencentcloud/iai/v20180301/models.py +3 -7
  24. tencentcloud/iai/v20200303/models.py +3 -7
  25. tencentcloud/lcic/v20220817/errorcodes.py +3 -0
  26. tencentcloud/lcic/v20220817/models.py +74 -0
  27. tencentcloud/monitor/v20180724/models.py +182 -2
  28. tencentcloud/monitor/v20180724/monitor_client.py +23 -0
  29. tencentcloud/mrs/v20200910/models.py +68 -0
  30. tencentcloud/oceanus/v20190422/models.py +15 -1
  31. tencentcloud/ses/v20201002/models.py +1 -1
  32. tencentcloud/sqlserver/v20180328/models.py +3 -3
  33. tencentcloud/sqlserver/v20180328/sqlserver_client.py +0 -1
  34. tencentcloud/ssl/v20191205/models.py +1836 -50
  35. tencentcloud/ssl/v20191205/ssl_client.py +69 -0
  36. tencentcloud/tdmq/v20200217/models.py +587 -1
  37. tencentcloud/tdmq/v20200217/tdmq_client.py +46 -0
  38. tencentcloud/tem/v20210701/errorcodes.py +3 -0
  39. tencentcloud/teo/v20220901/errorcodes.py +21 -0
  40. tencentcloud/teo/v20220901/models.py +96 -0
  41. tencentcloud/teo/v20220901/teo_client.py +23 -0
  42. tencentcloud/thpc/v20230321/models.py +33 -0
  43. tencentcloud/tione/v20211111/models.py +121 -0
  44. tencentcloud/trtc/v20190722/models.py +5 -2
  45. tencentcloud/tse/v20201207/models.py +13 -0
  46. tencentcloud/tsf/v20180326/models.py +4 -3
  47. tencentcloud/vpc/v20170312/errorcodes.py +3 -0
  48. tencentcloud/waf/v20180125/models.py +82 -0
  49. tencentcloud/waf/v20180125/waf_client.py +23 -0
  50. {tencentcloud_sdk_python-3.0.974.dist-info → tencentcloud_sdk_python-3.0.976.dist-info}/METADATA +1 -1
  51. {tencentcloud_sdk_python-3.0.974.dist-info → tencentcloud_sdk_python-3.0.976.dist-info}/RECORD +54 -54
  52. {tencentcloud_sdk_python-3.0.974.dist-info → tencentcloud_sdk_python-3.0.976.dist-info}/LICENSE +0 -0
  53. {tencentcloud_sdk_python-3.0.974.dist-info → tencentcloud_sdk_python-3.0.976.dist-info}/WHEEL +0 -0
  54. {tencentcloud_sdk_python-3.0.974.dist-info → tencentcloud_sdk_python-3.0.976.dist-info}/top_level.txt +0 -0
@@ -12609,7 +12609,7 @@ class ModifyInstancesAttributeRequest(AbstractModel):
12609
12609
  :type SecurityGroups: list of str
12610
12610
  :param _CamRoleName: 给实例绑定用户角色,传空值为解绑操作
12611
12611
  :type CamRoleName: str
12612
- :param _HostName: 实例的主机名。<br><li>点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。<br><li>Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。<br><li>其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
12612
+ :param _HostName: 实例的主机名。<br><li>点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。<br><li>Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。<br><li>其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。<br> 注意点:修改主机名后实例会立即重启,重启后新的主机名生效。
12613
12613
  :type HostName: str
12614
12614
  :param _DisableApiTermination: 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:<br><li>TRUE:表示开启实例保护,不允许通过api接口删除实例<br><li>FALSE:表示关闭实例保护,允许通过api接口删除实例<br><br>默认取值:FALSE。
12615
12615
  :type DisableApiTermination: bool
@@ -13349,15 +13349,12 @@ class Placement(AbstractModel):
13349
13349
  :type ProjectId: int
13350
13350
  :param _HostIds: 实例所属的专用宿主机ID列表,仅用于入参。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。
13351
13351
  :type HostIds: list of str
13352
- :param _HostIps: 指定母机IP生产子机
13353
- :type HostIps: list of str
13354
13352
  :param _HostId: 实例所属的专用宿主机ID,仅用于出参。
13355
13353
  :type HostId: str
13356
13354
  """
13357
13355
  self._Zone = None
13358
13356
  self._ProjectId = None
13359
13357
  self._HostIds = None
13360
- self._HostIps = None
13361
13358
  self._HostId = None
13362
13359
 
13363
13360
  @property
@@ -13384,14 +13381,6 @@ class Placement(AbstractModel):
13384
13381
  def HostIds(self, HostIds):
13385
13382
  self._HostIds = HostIds
13386
13383
 
13387
- @property
13388
- def HostIps(self):
13389
- return self._HostIps
13390
-
13391
- @HostIps.setter
13392
- def HostIps(self, HostIps):
13393
- self._HostIps = HostIps
13394
-
13395
13384
  @property
13396
13385
  def HostId(self):
13397
13386
  return self._HostId
@@ -13405,7 +13394,6 @@ class Placement(AbstractModel):
13405
13394
  self._Zone = params.get("Zone")
13406
13395
  self._ProjectId = params.get("ProjectId")
13407
13396
  self._HostIds = params.get("HostIds")
13408
- self._HostIps = params.get("HostIps")
13409
13397
  self._HostId = params.get("HostId")
13410
13398
  memeber_set = set(params.keys())
13411
13399
  for name, value in vars(self).items():
@@ -404,7 +404,7 @@ class AddInstancesRequest(AbstractModel):
404
404
  :type Cpu: int
405
405
  :param _Memory: 内存,单位为GB
406
406
  :type Memory: int
407
- :param _ReadOnlyCount: 新增只读实例数,取值范围为[0,4]
407
+ :param _ReadOnlyCount: 新增只读实例数,取值范围为(0,15]
408
408
  :type ReadOnlyCount: int
409
409
  :param _InstanceGrpId: 实例组ID,在已有RO组中新增实例时使用,不传则新增RO组。当前版本不建议传输该值。当前版本已废弃。
410
410
  :type InstanceGrpId: str
@@ -3251,7 +3251,8 @@ timeRollback,时间点回档
3251
3251
  :type TimeSpan: int
3252
3252
  :param _TimeUnit: 包年包月购买时长单位,['s','d','m','y']
3253
3253
  :type TimeUnit: str
3254
- :param _AutoRenewFlag: 包年包月购买是否自动续费,默认为0
3254
+ :param _AutoRenewFlag: 包年包月购买是否自动续费,默认为0
3255
+ 0标识默认续费方式,1表示自动续费,2表示手不自动续费。
3255
3256
  :type AutoRenewFlag: int
3256
3257
  :param _AutoVoucher: 是否自动选择代金券 1是 0否 默认为0
3257
3258
  :type AutoVoucher: int
@@ -8344,7 +8345,7 @@ class DescribeAccountPrivilegesResponse(AbstractModel):
8344
8345
 
8345
8346
  def __init__(self):
8346
8347
  r"""
8347
- :param _Privileges: 权限列表,示例值为:["select","update","delete","create","drop","references","index","alter","show_db","create_tmp_table","lock_tables","execute","create_view","show_view","create_routine","alter_routine","event","trigger"]
8348
+ :param _Privileges: 权限列表,示例值为:["","select","update","delete","create","drop","references","index","alter","show_db","create_tmp_table","lock_tables","execute","create_view","show_view","create_routine","alter_routine","event","trigger"]
8348
8349
  :type Privileges: list of str
8349
8350
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8350
8351
  :type RequestId: str
@@ -13030,9 +13031,11 @@ class DescribeResourcesByDealNameRequest(AbstractModel):
13030
13031
 
13031
13032
  def __init__(self):
13032
13033
  r"""
13033
- :param _DealName: 计费订单ID(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)
13034
+ :param _DealName: 计费订单ID(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)。
13035
+ DealName与DealNames至少应输入一项,两者都传时以DealName为准。
13034
13036
  :type DealName: str
13035
- :param _DealNames: 计费订单ID列表,可以一次查询若干条订单ID对应资源信息(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)
13037
+ :param _DealNames: 计费订单ID列表,可以一次查询若干条订单ID对应资源信息(如果计费还没回调业务发货,可能出现错误码InvalidParameterValue.DealNameNotFound,这种情况需要业务重试DescribeResourcesByDealName接口直到成功)。
13038
+ DealName与DealNames至少应输入一项,两者都传时以DealName为准。
13036
13039
  :type DealNames: list of str
13037
13040
  """
13038
13041
  self._DealName = None
@@ -17060,7 +17063,7 @@ class ModifyInstanceParamRequest(AbstractModel):
17060
17063
  :type ClusterId: str
17061
17064
  :param _InstanceIds: 实例ID
17062
17065
  :type InstanceIds: list of str
17063
- :param _ClusterParamList: 集群参数列表,例如 [{ "CurrentValue":"2", "ParamName":"innodb_stats_transient_sample_pages"}]
17066
+ :param _ClusterParamList: 集群参数列表,例如 [{ "CurrentValue":"2", "ParamName":"auto_increment_increment"}]
17064
17067
  :type ClusterParamList: list of ModifyParamItem
17065
17068
  :param _InstanceParamList: 实例参数列表,例如[{ "CurrentValue":"2", "ParamName":"innodb_stats_transient_sample_pages"}]
17066
17069
  :type InstanceParamList: list of ModifyParamItem
@@ -23,16 +23,16 @@ AUTHFAILURE_UNAUTHORIZEDOPERATION = 'AuthFailure.UnauthorizedOperation'
23
23
  # 操作失败。
24
24
  FAILEDOPERATION = 'FailedOperation'
25
25
 
26
- # 抱歉,该帐户已经被锁定。
26
+ # 抱歉,该账户已经被锁定。
27
27
  FAILEDOPERATION_ACCOUNTISLOCKED = 'FailedOperation.AccountIsLocked'
28
28
 
29
- # 您的帐号下包含个人豪华域名,不能直接升级,请联系销售。
29
+ # 您的账户下包含个人豪华域名,不能直接升级,请联系销售。
30
30
  FAILEDOPERATION_CONTAINSPERSONALVIP = 'FailedOperation.ContainsPersonalVip'
31
31
 
32
32
  # 此优惠券只能被免费域名使用。
33
33
  FAILEDOPERATION_COUPONFORFREEDOMAIN = 'FailedOperation.CouponForFreeDomain'
34
34
 
35
- # 您的帐户不满足使用此优惠券的条件。
35
+ # 您的账户不满足使用此优惠券的条件。
36
36
  FAILEDOPERATION_COUPONNOTSUPPORTED = 'FailedOperation.CouponNotSupported'
37
37
 
38
38
  # 域名已经使用过该类型的礼券了,不能重复使用。
@@ -80,7 +80,7 @@ FAILEDOPERATION_GETWHOISFAILED = 'FailedOperation.GetWhoisFailed'
80
80
  # 账户余额不足。
81
81
  FAILEDOPERATION_INSUFFICIENTBALANCE = 'FailedOperation.InsufficientBalance'
82
82
 
83
- # 帐号异地登录,请求被拒绝。
83
+ # 账号异地登录,请求被拒绝。
84
84
  FAILEDOPERATION_LOGINAREANOTALLOWED = 'FailedOperation.LoginAreaNotAllowed'
85
85
 
86
86
  # 登录失败,请检查账号和密码是否正确。
@@ -356,7 +356,7 @@ INVALIDPARAMETER_OFFSETINVALID = 'InvalidParameter.OffsetInvalid'
356
356
  # 无效的openid。
357
357
  INVALIDPARAMETER_OPENIDINVALID = 'InvalidParameter.OpenidInvalid'
358
358
 
359
- # 操作失败,请稍候再试。
359
+ # 操作失败,请稍后再试。
360
360
  INVALIDPARAMETER_OPERATEFAILED = 'InvalidParameter.OperateFailed'
361
361
 
362
362
  # 当前操作过于频繁,请 1 分钟后重试。
@@ -440,7 +440,7 @@ INVALIDPARAMETER_TIMESPANINVALID = 'InvalidParameter.TimeSpanInvalid'
440
440
  # 时间戳已过期。
441
441
  INVALIDPARAMETER_TIMESTAMPEXPIRED = 'InvalidParameter.TimestampExpired'
442
442
 
443
- # 当前帐号下的无效域名过多,暂时无法使用该功能。请将已有域名的 DNS 服务器正确指向 DNSPod 之后,再尝试添加。
443
+ # 当前账号下的无效域名过多,暂时无法使用该功能。请将已有域名的 DNS 服务器正确指向 DNSPod 之后,再尝试添加。
444
444
  INVALIDPARAMETER_TOOMANYINVALIDDOMAINS = 'InvalidParameter.TooManyInvalidDomains'
445
445
 
446
446
  # 域名无效。
@@ -605,7 +605,7 @@ REQUESTLIMITEXCEEDED = 'RequestLimitExceeded'
605
605
  # 您的IP添加了过多任务,请稍后重试。
606
606
  REQUESTLIMITEXCEEDED_BATCHTASKLIMIT = 'RequestLimitExceeded.BatchTaskLimit'
607
607
 
608
- # 您的帐号在短时间内添加了大量的域名,请控制添加频率。
608
+ # 您的账号在短时间内添加了大量的域名,请控制添加频率。
609
609
  REQUESTLIMITEXCEEDED_CREATEDOMAINLIMIT = 'RequestLimitExceeded.CreateDomainLimit'
610
610
 
611
611
  # API请求次数超出限制。
@@ -12673,7 +12673,7 @@ class WhoisInfo(AbstractModel):
12673
12673
  :param _IsQcloud: 是否是在腾讯云注册的域名
12674
12674
  注意:此字段可能返回 null,表示取不到有效值。
12675
12675
  :type IsQcloud: bool
12676
- :param _IsQcloudOwner: 是否当前操作帐号注册的域名
12676
+ :param _IsQcloudOwner: 是否当前操作账号注册的域名
12677
12677
  注意:此字段可能返回 null,表示取不到有效值。
12678
12678
  :type IsQcloudOwner: bool
12679
12679
  :param _NameServers: 域名配置的NS
@@ -3939,6 +3939,8 @@ class CreateSubnetRequest(AbstractModel):
3939
3939
  :type EcmRegion: str
3940
3940
  :param _Tags: 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]
3941
3941
  :type Tags: list of Tag
3942
+ :param _IPv6CidrBlock: IPv6 CIDR
3943
+ :type IPv6CidrBlock: str
3942
3944
  """
3943
3945
  self._VpcId = None
3944
3946
  self._SubnetName = None
@@ -3946,6 +3948,7 @@ class CreateSubnetRequest(AbstractModel):
3946
3948
  self._Zone = None
3947
3949
  self._EcmRegion = None
3948
3950
  self._Tags = None
3951
+ self._IPv6CidrBlock = None
3949
3952
 
3950
3953
  @property
3951
3954
  def VpcId(self):
@@ -3995,6 +3998,14 @@ class CreateSubnetRequest(AbstractModel):
3995
3998
  def Tags(self, Tags):
3996
3999
  self._Tags = Tags
3997
4000
 
4001
+ @property
4002
+ def IPv6CidrBlock(self):
4003
+ return self._IPv6CidrBlock
4004
+
4005
+ @IPv6CidrBlock.setter
4006
+ def IPv6CidrBlock(self, IPv6CidrBlock):
4007
+ self._IPv6CidrBlock = IPv6CidrBlock
4008
+
3998
4009
 
3999
4010
  def _deserialize(self, params):
4000
4011
  self._VpcId = params.get("VpcId")
@@ -4008,6 +4019,7 @@ class CreateSubnetRequest(AbstractModel):
4008
4019
  obj = Tag()
4009
4020
  obj._deserialize(item)
4010
4021
  self._Tags.append(obj)
4022
+ self._IPv6CidrBlock = params.get("IPv6CidrBlock")
4011
4023
  memeber_set = set(params.keys())
4012
4024
  for name, value in vars(self).items():
4013
4025
  property_name = name[1:]
@@ -65,6 +65,9 @@ INVALIDPARAMETERVALUE_PILOTZONENOTSUPPORTED = 'InvalidParameterValue.PilotZoneNo
65
65
  # 应用和实例不匹配。
66
66
  INVALIDPARAMETERVALUE_PROJECTANDINSTANCENOTMATCH = 'InvalidParameterValue.ProjectAndInstanceNotMatch'
67
67
 
68
+ # 应用实例ID不存在。
69
+ INVALIDPARAMETERVALUE_PROJECTINSTANCENOTFOUND = 'InvalidParameterValue.ProjectInstanceNotFound'
70
+
68
71
  # 运行时已删除。
69
72
  INVALIDPARAMETERVALUE_RUNTIMEALREADYDELETED = 'InvalidParameterValue.RuntimeAlreadyDeleted'
70
73
 
@@ -407,6 +407,9 @@ RESOURCESSOLDOUT_CBSSOLDOUT = 'ResourcesSoldOut.CbsSoldOut'
407
407
  # 云服务器已售罄。
408
408
  RESOURCESSOLDOUT_CVMSOLDOUT = 'ResourcesSoldOut.CvmSoldOut'
409
409
 
410
+ # appid不一致。
411
+ UNAUTHORIZEDOPERATION_APPIDMISMATCHED = 'UnauthorizedOperation.AppIdMismatched'
412
+
410
413
  # 校验账号操作无权限。
411
414
  UNAUTHORIZEDOPERATION_CHECKCAMAUTH = 'UnauthorizedOperation.CheckCamAuth'
412
415
 
@@ -50,9 +50,9 @@ class EssClient(AbstractClient):
50
50
 
51
51
 
52
52
  def CancelFlow(self, request):
53
- """用于撤销签署流程
54
- 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
55
- 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
53
+ """用于撤销签署流程<br/>
54
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
55
+ `注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
56
56
 
57
57
  :param request: Request instance for CancelFlow.
58
58
  :type request: :class:`tencentcloud.ess.v20201111.models.CancelFlowRequest`
@@ -75,7 +75,9 @@ class EssClient(AbstractClient):
75
75
 
76
76
 
77
77
  def CancelMultiFlowSignQRCode(self, request):
78
- """此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
78
+ """此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
79
+ 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
80
+ 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
79
81
 
80
82
  :param request: Request instance for CancelMultiFlowSignQRCode.
81
83
  :type request: :class:`tencentcloud.ess.v20201111.models.CancelMultiFlowSignQRCodeRequest`
@@ -100,6 +102,8 @@ class EssClient(AbstractClient):
100
102
  def CancelUserAutoSignEnableUrl(self, request):
101
103
  """此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
102
104
 
105
+ 注: `在调用此接口时,请确保指定的用户已生成自动签开通链接并且未完成开通,否则无法撤销`
106
+
103
107
  :param request: Request instance for CancelUserAutoSignEnableUrl.
104
108
  :type request: :class:`tencentcloud.ess.v20201111.models.CancelUserAutoSignEnableUrlRequest`
105
109
  :rtype: :class:`tencentcloud.ess.v20201111.models.CancelUserAutoSignEnableUrlResponse`
@@ -455,13 +459,12 @@ class EssClient(AbstractClient):
455
459
 
456
460
 
457
461
  def CreateFlowSignUrl(self, request):
458
- """创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
459
-
460
- 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
462
+ """该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
461
463
 
462
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
463
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
464
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
464
+ 注:
465
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
466
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
467
+ `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<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>
465
468
 
466
469
  :param request: Request instance for CreateFlowSignUrl.
467
470
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowSignUrlRequest`
@@ -587,7 +590,8 @@ class EssClient(AbstractClient):
587
590
 
588
591
  def CreateMultiFlowSignQRCode(self, request):
589
592
  """此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
590
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
593
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
594
+ 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
591
595
 
592
596
  **本接口适用于发起方没有填写控件的 B2C或者单C模板**
593
597
 
@@ -718,6 +722,13 @@ class EssClient(AbstractClient):
718
722
  def CreateReleaseFlow(self, request):
719
723
  """发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
720
724
 
725
+ `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
726
+ `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
727
+ `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
728
+ `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
729
+ `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
730
+ `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
731
+
721
732
  :param request: Request instance for CreateReleaseFlow.
722
733
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowRequest`
723
734
  :rtype: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowResponse`
@@ -739,17 +750,22 @@ class EssClient(AbstractClient):
739
750
 
740
751
 
741
752
  def CreateSchemeUrl(self, request):
742
- """获取小程序签署链接
753
+ """获取跳转至腾讯电子签小程序的签署链接
743
754
 
744
755
  适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
745
756
 
746
- 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
757
+ 跳转到小程序的实现,参考微信官方文档(分为<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>
747
758
 
759
+ 注:
760
+ `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
761
+ `2. 签署链接的有效期为90天,超过有效期链接不可用`
748
762
 
749
- 跳转到小程序的实现,参考官方文档(分为<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>两种方式)
763
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
750
764
 
751
-
752
- 如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
765
+ | 小程序 | AppID | 原始ID |
766
+ | ------------ | ------------ | ------------ |
767
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
768
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
753
769
 
754
770
  :param request: Request instance for CreateSchemeUrl.
755
771
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateSchemeUrlRequest`
@@ -959,7 +975,12 @@ class EssClient(AbstractClient):
959
975
 
960
976
 
961
977
  def DescribeExtendedServiceAuthInfos(self, request):
962
- """查询企业扩展服务授权信息,目前支持查询:企业静默签,企业与港澳台居民签署合同,使用手机号验证签署方身份,骑缝章,批量签署能力是否已经开通
978
+ """查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
979
+ 1. 企业静默签
980
+ 2. 企业与港澳台居民签署合同
981
+ 3. 使用手机号验证签署方身份
982
+ 4. 骑缝章
983
+ 5. 批量签署能力
963
984
 
964
985
  :param request: Request instance for DescribeExtendedServiceAuthInfos.
965
986
  :type request: :class:`tencentcloud.ess.v20201111.models.DescribeExtendedServiceAuthInfosRequest`
@@ -1054,7 +1075,7 @@ class EssClient(AbstractClient):
1054
1075
 
1055
1076
 
1056
1077
  def DescribeFlowEvidenceReport(self, request):
1057
- """查询出证报告,返回报告 URL。出证报告编号通过CreateFlowEvidenceReport接口获取。
1078
+ """查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
1058
1079
 
1059
1080
  :param request: Request instance for DescribeFlowEvidenceReport.
1060
1081
  :type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowEvidenceReportRequest`
@@ -1370,9 +1391,10 @@ class EssClient(AbstractClient):
1370
1391
 
1371
1392
 
1372
1393
  def ModifyApplicationCallbackInfo(self, request):
1373
- """新增/删除应用callbackinfo
1374
- callbackinfo包含: 回调地址和签名key
1375
- 操作:新增/删除
1394
+ """新增/删除企业应用集成中的回调配置。
1395
+ 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
1396
+ 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
1397
+ 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
1376
1398
 
1377
1399
  :param request: Request instance for ModifyApplicationCallbackInfo.
1378
1400
  :type request: :class:`tencentcloud.ess.v20201111.models.ModifyApplicationCallbackInfoRequest`
@@ -1450,9 +1472,9 @@ class EssClient(AbstractClient):
1450
1472
 
1451
1473
 
1452
1474
  def StartFlow(self, request):
1453
- """此接口用于发起流程
1454
- 适用场景:见创建签署流程接口。
1455
- 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
1475
+ """此接口用于启动流程。它是模板发起合同的最后一步。
1476
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
1477
+ 流程激活后,将生成一份待签署的电子合同。
1456
1478
 
1457
1479
  :param request: Request instance for StartFlow.
1458
1480
  :type request: :class:`tencentcloud.ess.v20201111.models.StartFlowRequest`