tencentcloud-sdk-python 3.0.1288__py2.py3-none-any.whl → 3.0.1290__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 (57) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/aiart/v20221229/models.py +17 -2
  3. tencentcloud/apm/v20210622/models.py +6 -0
  4. tencentcloud/cdb/v20170320/cdb_client.py +22 -23
  5. tencentcloud/cdb/v20170320/errorcodes.py +3 -0
  6. tencentcloud/cdb/v20170320/models.py +120 -76
  7. tencentcloud/cdwdoris/v20211228/models.py +43 -0
  8. tencentcloud/chdfs/v20201112/models.py +19 -31
  9. tencentcloud/clb/v20180317/clb_client.py +0 -1
  10. tencentcloud/clb/v20180317/models.py +45 -4
  11. tencentcloud/cloudapp/v20220530/cloudapp_client.py +1 -1
  12. tencentcloud/cloudaudit/v20190319/models.py +8 -0
  13. tencentcloud/cls/v20201016/models.py +2 -2
  14. tencentcloud/cynosdb/v20190107/cynosdb_client.py +4 -4
  15. tencentcloud/cynosdb/v20190107/errorcodes.py +3 -0
  16. tencentcloud/cynosdb/v20190107/models.py +4 -4
  17. tencentcloud/dbbrain/v20210527/models.py +4 -4
  18. tencentcloud/dc/v20180410/models.py +114 -18
  19. tencentcloud/dcdb/v20180411/models.py +4 -4
  20. tencentcloud/dlc/v20210125/models.py +255 -0
  21. tencentcloud/dts/v20180330/models.py +20 -20
  22. tencentcloud/dts/v20211206/models.py +17 -17
  23. tencentcloud/ecm/v20190719/models.py +0 -8
  24. tencentcloud/ess/v20201111/models.py +68 -14
  25. tencentcloud/essbasic/v20210526/essbasic_client.py +60 -0
  26. tencentcloud/essbasic/v20210526/models.py +570 -0
  27. tencentcloud/facefusion/v20220927/models.py +2 -6
  28. tencentcloud/fmu/v20191213/models.py +16 -0
  29. tencentcloud/hai/v20230812/models.py +6 -4
  30. tencentcloud/hunyuan/v20230901/models.py +38 -0
  31. tencentcloud/lcic/v20220817/models.py +4 -2
  32. tencentcloud/lighthouse/v20200324/lighthouse_client.py +11 -2
  33. tencentcloud/live/v20180801/models.py +0 -18
  34. tencentcloud/mongodb/v20190725/models.py +17 -4
  35. tencentcloud/msp/v20180319/msp_client.py +3 -1
  36. tencentcloud/ocr/v20181119/ocr_client.py +1 -1
  37. tencentcloud/omics/v20221128/models.py +15 -0
  38. tencentcloud/redis/v20180412/models.py +2 -2
  39. tencentcloud/sqlserver/v20180328/models.py +256 -12
  40. tencentcloud/sqlserver/v20180328/sqlserver_client.py +2 -2
  41. tencentcloud/tdmq/v20200217/models.py +109 -0
  42. tencentcloud/tdmq/v20200217/tdmq_client.py +23 -0
  43. tencentcloud/trocket/v20230308/models.py +970 -51
  44. tencentcloud/trocket/v20230308/trocket_client.py +69 -0
  45. tencentcloud/trtc/v20190722/errorcodes.py +3 -0
  46. tencentcloud/tse/v20201207/models.py +90 -0
  47. tencentcloud/tsf/v20180326/models.py +4 -4
  48. tencentcloud/tsf/v20180326/tsf_client.py +3 -1
  49. tencentcloud/vclm/v20240523/models.py +6 -4
  50. tencentcloud/vod/v20180717/models.py +48 -0
  51. tencentcloud/vpc/v20170312/errorcodes.py +15 -0
  52. tencentcloud/vpc/v20170312/models.py +0 -28
  53. {tencentcloud_sdk_python-3.0.1288.dist-info → tencentcloud_sdk_python-3.0.1290.dist-info}/METADATA +1 -1
  54. {tencentcloud_sdk_python-3.0.1288.dist-info → tencentcloud_sdk_python-3.0.1290.dist-info}/RECORD +57 -57
  55. {tencentcloud_sdk_python-3.0.1288.dist-info → tencentcloud_sdk_python-3.0.1290.dist-info}/LICENSE +0 -0
  56. {tencentcloud_sdk_python-3.0.1288.dist-info → tencentcloud_sdk_python-3.0.1290.dist-info}/WHEEL +0 -0
  57. {tencentcloud_sdk_python-3.0.1288.dist-info → tencentcloud_sdk_python-3.0.1290.dist-info}/top_level.txt +0 -0
@@ -4320,36 +4320,36 @@ class SubscribeInfo(AbstractModel):
4320
4320
  :type SubscribeId: str
4321
4321
  :param _SubscribeName: 数据订阅实例的名称
4322
4322
  :type SubscribeName: str
4323
- :param _ChannelId: 数据订阅实例绑定的通道ID
4323
+ :param _ChannelId: 数据订阅实例绑定的通道ID。kafka版订阅就是kafka topic
4324
4324
  :type ChannelId: str
4325
- :param _Product: 数据订阅绑定实例对应的产品名称
4325
+ :param _Product: 订阅实例的类型,目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
4326
4326
  :type Product: str
4327
4327
  :param _InstanceId: 数据订阅实例绑定的数据库实例ID
4328
4328
  :type InstanceId: str
4329
- :param _InstanceStatus: 数据订阅实例绑定的数据库实例状态
4329
+ :param _InstanceStatus: 云数据库状态:running 运行中,isolated 已隔离,offline 已下线。如果不是云上,此值为空
4330
4330
  :type InstanceStatus: str
4331
- :param _SubsStatus: 数据订阅实例的配置状态,unconfigure - 未配置, configuring - 配置中,configured - 已配置
4331
+ :param _SubsStatus: 数据订阅状态,可能的值为:未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
4332
4332
  :type SubsStatus: str
4333
- :param _ModifyTime: 上次修改时间
4333
+ :param _ModifyTime: 上次修改时间,时间格式如:Y-m-d h:m:s
4334
4334
  :type ModifyTime: str
4335
4335
  :param _CreateTime: 创建时间
4336
4336
  :type CreateTime: str
4337
- :param _IsolateTime: 隔离时间
4337
+ :param _IsolateTime: 隔离时间,时间格式如:Y-m-d h:m:s
4338
4338
  :type IsolateTime: str
4339
- :param _ExpireTime: 到期时间
4339
+ :param _ExpireTime: 包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
4340
4340
  :type ExpireTime: str
4341
4341
  :param _OfflineTime: 下线时间
4342
4342
  :type OfflineTime: str
4343
4343
  :param _ConsumeStartTime: 最近一次修改的消费时间起点,如果从未修改则为零值
4344
4344
  :type ConsumeStartTime: str
4345
- :param _AutoRenewFlag: 自动续费标识。0-不自动续费,1-自动续费
4345
+ :param _AutoRenewFlag: 自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
4346
4346
  注意:此字段可能返回 null,表示取不到有效值。
4347
4347
  :type AutoRenewFlag: int
4348
4348
  :param _Region: 数据订阅实例所属地域
4349
4349
  :type Region: str
4350
4350
  :param _PayType: 计费方式,0 - 包年包月,1 - 按量计费
4351
4351
  :type PayType: int
4352
- :param _Vip: 数据订阅实例的Vip
4352
+ :param _Vip: 旧版订阅通道的vip
4353
4353
  :type Vip: str
4354
4354
  :param _Vport: 数据订阅实例的Vport
4355
4355
  :type Vport: int
@@ -4357,7 +4357,7 @@ class SubscribeInfo(AbstractModel):
4357
4357
  :type UniqVpcId: str
4358
4358
  :param _UniqSubnetId: 数据订阅实例Vip所在子网的唯一ID
4359
4359
  :type UniqSubnetId: str
4360
- :param _Status: 数据订阅实例的状态,creating - 创建中,normal - 正常运行,isolating - 隔离中,isolated - 已隔离,offlining - 下线中,offline - 已下线
4360
+ :param _Status: 数据订阅生命周期状态,可能的值为:正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining, 按量转包年包月中 post2PrePayIng
4361
4361
  :type Status: str
4362
4362
  :param _SdkConsumedTime: SDK最后一条确认消息的时间戳,如果SDK一直消费,也可以作为SDK当前消费时间点
4363
4363
  :type SdkConsumedTime: str
@@ -4417,7 +4417,7 @@ class SubscribeInfo(AbstractModel):
4417
4417
 
4418
4418
  @property
4419
4419
  def ChannelId(self):
4420
- """数据订阅实例绑定的通道ID
4420
+ """数据订阅实例绑定的通道ID。kafka版订阅就是kafka topic
4421
4421
  :rtype: str
4422
4422
  """
4423
4423
  return self._ChannelId
@@ -4428,7 +4428,7 @@ class SubscribeInfo(AbstractModel):
4428
4428
 
4429
4429
  @property
4430
4430
  def Product(self):
4431
- """数据订阅绑定实例对应的产品名称
4431
+ """订阅实例的类型,目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql)
4432
4432
  :rtype: str
4433
4433
  """
4434
4434
  return self._Product
@@ -4450,7 +4450,7 @@ class SubscribeInfo(AbstractModel):
4450
4450
 
4451
4451
  @property
4452
4452
  def InstanceStatus(self):
4453
- """数据订阅实例绑定的数据库实例状态
4453
+ """云数据库状态:running 运行中,isolated 已隔离,offline 已下线。如果不是云上,此值为空
4454
4454
  :rtype: str
4455
4455
  """
4456
4456
  return self._InstanceStatus
@@ -4461,7 +4461,7 @@ class SubscribeInfo(AbstractModel):
4461
4461
 
4462
4462
  @property
4463
4463
  def SubsStatus(self):
4464
- """数据订阅实例的配置状态,unconfigure - 未配置, configuring - 配置中,configured - 已配置
4464
+ """数据订阅状态,可能的值为:未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error
4465
4465
  :rtype: str
4466
4466
  """
4467
4467
  return self._SubsStatus
@@ -4472,7 +4472,7 @@ class SubscribeInfo(AbstractModel):
4472
4472
 
4473
4473
  @property
4474
4474
  def ModifyTime(self):
4475
- """上次修改时间
4475
+ """上次修改时间,时间格式如:Y-m-d h:m:s
4476
4476
  :rtype: str
4477
4477
  """
4478
4478
  return self._ModifyTime
@@ -4494,7 +4494,7 @@ class SubscribeInfo(AbstractModel):
4494
4494
 
4495
4495
  @property
4496
4496
  def IsolateTime(self):
4497
- """隔离时间
4497
+ """隔离时间,时间格式如:Y-m-d h:m:s
4498
4498
  :rtype: str
4499
4499
  """
4500
4500
  return self._IsolateTime
@@ -4505,7 +4505,7 @@ class SubscribeInfo(AbstractModel):
4505
4505
 
4506
4506
  @property
4507
4507
  def ExpireTime(self):
4508
- """到期时间
4508
+ """包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00
4509
4509
  :rtype: str
4510
4510
  """
4511
4511
  return self._ExpireTime
@@ -4538,7 +4538,7 @@ class SubscribeInfo(AbstractModel):
4538
4538
 
4539
4539
  @property
4540
4540
  def AutoRenewFlag(self):
4541
- """自动续费标识。0-不自动续费,1-自动续费
4541
+ """自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费
4542
4542
  注意:此字段可能返回 null,表示取不到有效值。
4543
4543
  :rtype: int
4544
4544
  """
@@ -4572,7 +4572,7 @@ class SubscribeInfo(AbstractModel):
4572
4572
 
4573
4573
  @property
4574
4574
  def Vip(self):
4575
- """数据订阅实例的Vip
4575
+ """旧版订阅通道的vip
4576
4576
  :rtype: str
4577
4577
  """
4578
4578
  return self._Vip
@@ -4616,7 +4616,7 @@ class SubscribeInfo(AbstractModel):
4616
4616
 
4617
4617
  @property
4618
4618
  def Status(self):
4619
- """数据订阅实例的状态,creating - 创建中,normal - 正常运行,isolating - 隔离中,isolated - 已隔离,offlining - 下线中,offline - 已下线
4619
+ """数据订阅生命周期状态,可能的值为:正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining, 按量转包年包月中 post2PrePayIng
4620
4620
  :rtype: str
4621
4621
  """
4622
4622
  return self._Status
@@ -12482,16 +12482,16 @@ class ModifyConsumerGroupPasswordRequest(AbstractModel):
12482
12482
  :type AccountName: str
12483
12483
  :param _ConsumerGroupName: 消费组名称。实际的消费组全称形如:consumer-grp-#{SubscribeId}-#{ConsumerGroupName}
12484
12484
  :type ConsumerGroupName: str
12485
- :param _OldPassword: 旧密码
12486
- :type OldPassword: str
12487
12485
  :param _NewPassword: 新密码。字符长度不小于3,不大于32
12488
12486
  :type NewPassword: str
12487
+ :param _OldPassword: 旧密码,非必选
12488
+ :type OldPassword: str
12489
12489
  """
12490
12490
  self._SubscribeId = None
12491
12491
  self._AccountName = None
12492
12492
  self._ConsumerGroupName = None
12493
- self._OldPassword = None
12494
12493
  self._NewPassword = None
12494
+ self._OldPassword = None
12495
12495
 
12496
12496
  @property
12497
12497
  def SubscribeId(self):
@@ -12526,17 +12526,6 @@ class ModifyConsumerGroupPasswordRequest(AbstractModel):
12526
12526
  def ConsumerGroupName(self, ConsumerGroupName):
12527
12527
  self._ConsumerGroupName = ConsumerGroupName
12528
12528
 
12529
- @property
12530
- def OldPassword(self):
12531
- """旧密码
12532
- :rtype: str
12533
- """
12534
- return self._OldPassword
12535
-
12536
- @OldPassword.setter
12537
- def OldPassword(self, OldPassword):
12538
- self._OldPassword = OldPassword
12539
-
12540
12529
  @property
12541
12530
  def NewPassword(self):
12542
12531
  """新密码。字符长度不小于3,不大于32
@@ -12548,13 +12537,24 @@ class ModifyConsumerGroupPasswordRequest(AbstractModel):
12548
12537
  def NewPassword(self, NewPassword):
12549
12538
  self._NewPassword = NewPassword
12550
12539
 
12540
+ @property
12541
+ def OldPassword(self):
12542
+ """旧密码,非必选
12543
+ :rtype: str
12544
+ """
12545
+ return self._OldPassword
12546
+
12547
+ @OldPassword.setter
12548
+ def OldPassword(self, OldPassword):
12549
+ self._OldPassword = OldPassword
12550
+
12551
12551
 
12552
12552
  def _deserialize(self, params):
12553
12553
  self._SubscribeId = params.get("SubscribeId")
12554
12554
  self._AccountName = params.get("AccountName")
12555
12555
  self._ConsumerGroupName = params.get("ConsumerGroupName")
12556
- self._OldPassword = params.get("OldPassword")
12557
12556
  self._NewPassword = params.get("NewPassword")
12557
+ self._OldPassword = params.get("OldPassword")
12558
12558
  memeber_set = set(params.keys())
12559
12559
  for name, value in vars(self).items():
12560
12560
  property_name = name[1:]
@@ -14029,7 +14029,7 @@ class Options(AbstractModel):
14029
14029
  :param _AutoRetryTimeRangeMinutes: 自动重试的时间窗口设置
14030
14030
  注意:此字段可能返回 null,表示取不到有效值。
14031
14031
  :type AutoRetryTimeRangeMinutes: int
14032
- :param _StartPosition: 同步到kafka链路指定位点。目前只支持时间格式:yyyy-mm-dd hh:mm:ss。如果没有指定位点,为空。
14032
+ :param _StartPosition: 同步到kafka链路指定位点。目前只支持时间格式:2023-12-20T19:24:23+08:00。如果没有指定位点,为空。
14033
14033
  注意:此字段可能返回 null,表示取不到有效值。
14034
14034
  :type StartPosition: str
14035
14035
  :param _FilterBeginCommit: 同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
@@ -14175,7 +14175,7 @@ class Options(AbstractModel):
14175
14175
 
14176
14176
  @property
14177
14177
  def StartPosition(self):
14178
- """同步到kafka链路指定位点。目前只支持时间格式:yyyy-mm-dd hh:mm:ss。如果没有指定位点,为空。
14178
+ """同步到kafka链路指定位点。目前只支持时间格式:2023-12-20T19:24:23+08:00。如果没有指定位点,为空。
14179
14179
  注意:此字段可能返回 null,表示取不到有效值。
14180
14180
  :rtype: str
14181
14181
  """
@@ -1467,7 +1467,6 @@ class AssignPrivateIpAddressesResponse(AbstractModel):
1467
1467
  def __init__(self):
1468
1468
  r"""
1469
1469
  :param _PrivateIpAddressSet: 内网IP详细信息。
1470
- 注意:此字段可能返回 null,表示取不到有效值。
1471
1470
  :type PrivateIpAddressSet: list of PrivateIpAddressSpecification
1472
1471
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1473
1472
  :type RequestId: str
@@ -1478,7 +1477,6 @@ class AssignPrivateIpAddressesResponse(AbstractModel):
1478
1477
  @property
1479
1478
  def PrivateIpAddressSet(self):
1480
1479
  """内网IP详细信息。
1481
- 注意:此字段可能返回 null,表示取不到有效值。
1482
1480
  :rtype: list of PrivateIpAddressSpecification
1483
1481
  """
1484
1482
  return self._PrivateIpAddressSet
@@ -4374,7 +4372,6 @@ class CreateRoutesResponse(AbstractModel):
4374
4372
  :param _TotalCount: 新增的实例个数。
4375
4373
  :type TotalCount: int
4376
4374
  :param _RouteTableSet: 路由表对象。
4377
- 注意:此字段可能返回 null,表示取不到有效值。
4378
4375
  :type RouteTableSet: list of RouteTable
4379
4376
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4380
4377
  :type RequestId: str
@@ -4397,7 +4394,6 @@ class CreateRoutesResponse(AbstractModel):
4397
4394
  @property
4398
4395
  def RouteTableSet(self):
4399
4396
  """路由表对象。
4400
- 注意:此字段可能返回 null,表示取不到有效值。
4401
4397
  :rtype: list of RouteTable
4402
4398
  """
4403
4399
  return self._RouteTableSet
@@ -7203,7 +7199,6 @@ class DescribeHaVipsResponse(AbstractModel):
7203
7199
  :param _TotalCount: 符合条件的对象数。
7204
7200
  :type TotalCount: int
7205
7201
  :param _HaVipSet: HAVIP对象数组。
7206
- 注意:此字段可能返回 null,表示取不到有效值。
7207
7202
  :type HaVipSet: list of HaVip
7208
7203
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7209
7204
  :type RequestId: str
@@ -7226,7 +7221,6 @@ class DescribeHaVipsResponse(AbstractModel):
7226
7221
  @property
7227
7222
  def HaVipSet(self):
7228
7223
  """HAVIP对象数组。
7229
- 注意:此字段可能返回 null,表示取不到有效值。
7230
7224
  :rtype: list of HaVip
7231
7225
  """
7232
7226
  return self._HaVipSet
@@ -9820,7 +9814,6 @@ class DescribeRouteConflictsResponse(AbstractModel):
9820
9814
  def __init__(self):
9821
9815
  r"""
9822
9816
  :param _RouteConflictSet: 路由策略冲突列表
9823
- 注意:此字段可能返回 null,表示取不到有效值。
9824
9817
  :type RouteConflictSet: list of RouteConflict
9825
9818
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9826
9819
  :type RequestId: str
@@ -9831,7 +9824,6 @@ class DescribeRouteConflictsResponse(AbstractModel):
9831
9824
  @property
9832
9825
  def RouteConflictSet(self):
9833
9826
  """路由策略冲突列表
9834
- 注意:此字段可能返回 null,表示取不到有效值。
9835
9827
  :rtype: list of RouteConflict
9836
9828
  """
9837
9829
  return self._RouteConflictSet
@@ -5146,6 +5146,12 @@ class CreateBatchSignUrlRequest(AbstractModel):
5146
5146
  2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
5147
5147
  3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
5148
5148
  :type AutoJumpBack: bool
5149
+ :param _UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
5150
+
5151
+ 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
5152
+
5153
+ 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
5154
+ :type UrlUseEnv: str
5149
5155
  """
5150
5156
  self._Operator = None
5151
5157
  self._Name = None
@@ -5159,6 +5165,7 @@ class CreateBatchSignUrlRequest(AbstractModel):
5159
5165
  self._JumpToDetail = None
5160
5166
  self._FlowBatchUrlInfo = None
5161
5167
  self._AutoJumpBack = None
5168
+ self._UrlUseEnv = None
5162
5169
 
5163
5170
  @property
5164
5171
  def Operator(self):
@@ -5332,6 +5339,21 @@ class CreateBatchSignUrlRequest(AbstractModel):
5332
5339
  def AutoJumpBack(self, AutoJumpBack):
5333
5340
  self._AutoJumpBack = AutoJumpBack
5334
5341
 
5342
+ @property
5343
+ def UrlUseEnv(self):
5344
+ """签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
5345
+
5346
+ 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
5347
+
5348
+ 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
5349
+ :rtype: str
5350
+ """
5351
+ return self._UrlUseEnv
5352
+
5353
+ @UrlUseEnv.setter
5354
+ def UrlUseEnv(self, UrlUseEnv):
5355
+ self._UrlUseEnv = UrlUseEnv
5356
+
5335
5357
 
5336
5358
  def _deserialize(self, params):
5337
5359
  if params.get("Operator") is not None:
@@ -5352,6 +5374,7 @@ class CreateBatchSignUrlRequest(AbstractModel):
5352
5374
  self._FlowBatchUrlInfo = FlowBatchUrlInfo()
5353
5375
  self._FlowBatchUrlInfo._deserialize(params.get("FlowBatchUrlInfo"))
5354
5376
  self._AutoJumpBack = params.get("AutoJumpBack")
5377
+ self._UrlUseEnv = params.get("UrlUseEnv")
5355
5378
  memeber_set = set(params.keys())
5356
5379
  for name, value in vars(self).items():
5357
5380
  property_name = name[1:]
@@ -13764,6 +13787,14 @@ class CreateSchemeUrlRequest(AbstractModel):
13764
13787
  :type RecipientId: str
13765
13788
  :param _FlowGroupUrlInfo: 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
13766
13789
  :type FlowGroupUrlInfo: :class:`tencentcloud.ess.v20201111.models.FlowGroupUrlInfo`
13790
+ :param _UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
13791
+
13792
+ 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
13793
+
13794
+ 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
13795
+
13796
+
13797
+ :type UrlUseEnv: str
13767
13798
  """
13768
13799
  self._Operator = None
13769
13800
  self._OrganizationName = None
@@ -13780,6 +13811,7 @@ class CreateSchemeUrlRequest(AbstractModel):
13780
13811
  self._Hides = None
13781
13812
  self._RecipientId = None
13782
13813
  self._FlowGroupUrlInfo = None
13814
+ self._UrlUseEnv = None
13783
13815
 
13784
13816
  @property
13785
13817
  def Operator(self):
@@ -13975,6 +14007,23 @@ class CreateSchemeUrlRequest(AbstractModel):
13975
14007
  def FlowGroupUrlInfo(self, FlowGroupUrlInfo):
13976
14008
  self._FlowGroupUrlInfo = FlowGroupUrlInfo
13977
14009
 
14010
+ @property
14011
+ def UrlUseEnv(self):
14012
+ """签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
14013
+
14014
+ 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
14015
+
14016
+ 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
14017
+
14018
+
14019
+ :rtype: str
14020
+ """
14021
+ return self._UrlUseEnv
14022
+
14023
+ @UrlUseEnv.setter
14024
+ def UrlUseEnv(self, UrlUseEnv):
14025
+ self._UrlUseEnv = UrlUseEnv
14026
+
13978
14027
 
13979
14028
  def _deserialize(self, params):
13980
14029
  if params.get("Operator") is not None:
@@ -13998,6 +14047,7 @@ class CreateSchemeUrlRequest(AbstractModel):
13998
14047
  if params.get("FlowGroupUrlInfo") is not None:
13999
14048
  self._FlowGroupUrlInfo = FlowGroupUrlInfo()
14000
14049
  self._FlowGroupUrlInfo._deserialize(params.get("FlowGroupUrlInfo"))
14050
+ self._UrlUseEnv = params.get("UrlUseEnv")
14001
14051
  memeber_set = set(params.keys())
14002
14052
  for name, value in vars(self).items():
14003
14053
  property_name = name[1:]
@@ -15279,8 +15329,8 @@ class CreateUserMobileChangeUrlRequest(AbstractModel):
15279
15329
  :type IdCardType: str
15280
15330
  :param _IdCardNumber: 要修改手机号用户的身份证号码,应符合以下规则
15281
15331
  <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
15282
- <li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
15283
- <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
15332
+ <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
15333
+ <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
15284
15334
  如果没有传递 userId且 userAccountType 是 0 或者没有传递, 此参数为<b>必填项。</b>
15285
15335
  :type IdCardNumber: str
15286
15336
  :param _Endpoint: 要跳转的链接类型
@@ -15394,8 +15444,8 @@ class CreateUserMobileChangeUrlRequest(AbstractModel):
15394
15444
  def IdCardNumber(self):
15395
15445
  """要修改手机号用户的身份证号码,应符合以下规则
15396
15446
  <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
15397
- <li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
15398
- <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
15447
+ <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
15448
+ <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
15399
15449
  如果没有传递 userId且 userAccountType 是 0 或者没有传递, 此参数为<b>必填项。</b>
15400
15450
  :rtype: str
15401
15451
  """
@@ -18900,7 +18950,9 @@ class DescribeFlowTemplatesRequest(AbstractModel):
18900
18950
  <li>**1**:仅模板列表</li></ul>
18901
18951
  :type ContentType: int
18902
18952
  :param _Filters: 搜索条件,本字段用于指定模板Id进行查询。
18903
- Key:template-id Values:需要查询的模板Id列表
18953
+ - Key:template-id Values:需要查询的模板Id列表
18954
+ - Key:template-name Values:需要查询的模板名称列表
18955
+
18904
18956
  :type Filters: list of Filter
18905
18957
  :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
18906
18958
 
@@ -18978,7 +19030,9 @@ Key:template-id Values:需要查询的模板Id列表
18978
19030
  @property
18979
19031
  def Filters(self):
18980
19032
  """搜索条件,本字段用于指定模板Id进行查询。
18981
- Key:template-id Values:需要查询的模板Id列表
19033
+ - Key:template-id Values:需要查询的模板Id列表
19034
+ - Key:template-name Values:需要查询的模板名称列表
19035
+
18982
19036
  :rtype: list of Filter
18983
19037
  """
18984
19038
  return self._Filters
@@ -22453,8 +22507,8 @@ WEWORKAPP: 企业微信
22453
22507
  :type OrganizationName: str
22454
22508
  :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
22455
22509
  <ul><li>ID_CARD 中国大陆居民身份证</li>
22456
- <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
22457
- <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
22510
+ <li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
22511
+ <li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
22458
22512
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
22459
22513
 
22460
22514
  注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
@@ -22558,8 +22612,8 @@ WEWORKAPP: 企业微信
22558
22612
  def ApproverIdCardType(self):
22559
22613
  """签署方经办人的证件类型,支持以下类型
22560
22614
  <ul><li>ID_CARD 中国大陆居民身份证</li>
22561
- <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
22562
- <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
22615
+ <li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
22616
+ <li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
22563
22617
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
22564
22618
 
22565
22619
  注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
@@ -27435,8 +27489,8 @@ class NeedReviewApproverInfo(AbstractModel):
27435
27489
  :type ApproverMobile: str
27436
27490
  :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
27437
27491
  <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
27438
- <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
27439
- <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
27492
+ <li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
27493
+ <li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)</li>
27440
27494
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
27441
27495
 
27442
27496
  注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
@@ -27499,8 +27553,8 @@ class NeedReviewApproverInfo(AbstractModel):
27499
27553
  def ApproverIdCardType(self):
27500
27554
  """签署方经办人的证件类型,支持以下类型
27501
27555
  <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
27502
- <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
27503
- <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
27556
+ <li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
27557
+ <li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)</li>
27504
27558
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
27505
27559
 
27506
27560
  注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
@@ -26,6 +26,36 @@ class EssbasicClient(AbstractClient):
26
26
  _service = 'essbasic'
27
27
 
28
28
 
29
+ def ArchiveDynamicFlow(self, request):
30
+ """该接口用于结束动态签署方2.0的合同流程。
31
+
32
+
33
+ **功能开通**
34
+ - 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>,然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
35
+
36
+ **使用条件**
37
+ - 此接口只能在<font color="red">合同处于非终态且<b>所有的签署方都已经完成签署</b></font>。一旦合同进入终态(例如:过期、拒签、撤销或者调用过此接口成功过),将无法通过此接口结束合同流程。
38
+
39
+ :param request: Request instance for ArchiveDynamicFlow.
40
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.ArchiveDynamicFlowRequest`
41
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.ArchiveDynamicFlowResponse`
42
+
43
+ """
44
+ try:
45
+ params = request._serialize()
46
+ headers = request.headers
47
+ body = self.call("ArchiveDynamicFlow", params, headers=headers)
48
+ response = json.loads(body)
49
+ model = models.ArchiveDynamicFlowResponse()
50
+ model._deserialize(response["Response"])
51
+ return model
52
+ except Exception as e:
53
+ if isinstance(e, TencentCloudSDKException):
54
+ raise
55
+ else:
56
+ raise TencentCloudSDKException(type(e).__name__, str(e))
57
+
58
+
29
59
  def ChannelBatchCancelFlows(self, request):
30
60
  """通过合同编号批量撤销合同,单次最多支持撤销100份合同。
31
61
 
@@ -316,6 +346,36 @@ class EssbasicClient(AbstractClient):
316
346
  raise TencentCloudSDKException(type(e).__name__, str(e))
317
347
 
318
348
 
349
+ def ChannelCreateDynamicFlowApprover(self, request):
350
+ """接口(ChannelCreateDynamicFlowApprover)用来补充<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>发起的动态合同的签署人信息
351
+ **注**:
352
+ <ul>
353
+ <li>此接口需要保证:渠道企业已开启:模块化计费能力,</li>
354
+ <li>此接口需要保证:渠道应用已开启:动态签署人2.0能力</li>
355
+ <li>此接口需要保证:合同发起时指定开启了动态合同</li>
356
+ <li>此接口补充的动态签署人传参规则,请参考接口:<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>的签署人传参规则</li>
357
+ </ul>
358
+
359
+ :param request: Request instance for ChannelCreateDynamicFlowApprover.
360
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateDynamicFlowApproverRequest`
361
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateDynamicFlowApproverResponse`
362
+
363
+ """
364
+ try:
365
+ params = request._serialize()
366
+ headers = request.headers
367
+ body = self.call("ChannelCreateDynamicFlowApprover", params, headers=headers)
368
+ response = json.loads(body)
369
+ model = models.ChannelCreateDynamicFlowApproverResponse()
370
+ model._deserialize(response["Response"])
371
+ return model
372
+ except Exception as e:
373
+ if isinstance(e, TencentCloudSDKException):
374
+ raise
375
+ else:
376
+ raise TencentCloudSDKException(type(e).__name__, str(e))
377
+
378
+
319
379
  def ChannelCreateEmbedWebUrl(self, request):
320
380
  """本接口(ChannelCreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
321
381
  1. 创建印章