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

@@ -839,25 +839,34 @@ class ChannelBatchCancelFlowsRequest(AbstractModel):
839
839
 
840
840
  def __init__(self):
841
841
  r"""
842
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
842
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
843
+
844
+ 此接口下面信息必填。
845
+ <ul>
846
+ <li>渠道应用标识: Agent.AppId</li>
847
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
848
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
849
+ </ul>
850
+ 第三方平台子客企业和员工必须已经经过实名认证
843
851
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
844
- :param _FlowIds: 签署流程Id数组,最多100个,超过100不处理
852
+ :param _FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
845
853
  :type FlowIds: list of str
846
- :param _CancelMessage: 撤销理由,不超过200个字符
854
+ :param _CancelMessage: 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
855
+
856
+ 备注:`如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"`
847
857
  :type CancelMessage: str
848
- :param _CancelMessageFormat: 撤销理由自定义格式,支持以下格式
849
- <ul><li>0 : 默认值</li>
850
- <li>1 : 只保留身份信息</li>
851
- <li>2 : 保留身份信息+企业名称</li>
852
- <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
853
- 例如,假设合同的发起方是典子谦示例企业的经办人张三,撤销理由是"合同内容错误,需要修正",合同撤销后,各签署方看到的撤销理由是会是
854
-
855
- 0: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同
856
- 1: 发起方以"合同内容错误,需要修正"的理由撤销当前合同
857
- 2: 发起方-典子谦示例企业以"合同内容错误,需要修正"的理由撤销当前合同
858
- 3: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同</br>
859
-
860
- 备注:`如果不传递撤销理由,那么默认撤销理由是 "自动撤销(通过接口实现)"`
858
+ :param _CancelMessageFormat: 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
859
+
860
+ **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
861
+ **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
862
+ **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
863
+ **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
864
+
865
+ 注: `CancelMessage为撤销当前合同的理由`
866
+
867
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
868
+
869
+
861
870
  :type CancelMessageFormat: int
862
871
  :param _Operator: 暂未开放
863
872
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -940,7 +949,7 @@ class ChannelBatchCancelFlowsResponse(AbstractModel):
940
949
 
941
950
  def __init__(self):
942
951
  r"""
943
- :param _FailMessages: 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为“”,失败则对应失败消息
952
+ :param _FailMessages: 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
944
953
  :type FailMessages: list of str
945
954
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
946
955
  :type RequestId: str
@@ -1305,9 +1314,17 @@ class ChannelCreateBatchCancelFlowUrlRequest(AbstractModel):
1305
1314
 
1306
1315
  def __init__(self):
1307
1316
  r"""
1308
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1317
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1318
+
1319
+ 此接口下面信息必填。
1320
+ <ul>
1321
+ <li>渠道应用标识: Agent.AppId</li>
1322
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1323
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1324
+ </ul>
1325
+ 第三方平台子客企业和员工必须已经经过实名认证
1309
1326
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1310
- :param _FlowIds: 签署流程Id数组
1327
+ :param _FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
1311
1328
  :type FlowIds: list of str
1312
1329
  :param _Operator: 暂未开放
1313
1330
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -1370,11 +1387,13 @@ class ChannelCreateBatchCancelFlowUrlResponse(AbstractModel):
1370
1387
 
1371
1388
  def __init__(self):
1372
1389
  r"""
1373
- :param _BatchCancelFlowUrl: 批量撤销url
1390
+ :param _BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
1374
1391
  :type BatchCancelFlowUrl: str
1375
- :param _FailMessages: 签署流程批量撤销失败原因
1392
+ :param _FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
1376
1393
  :type FailMessages: list of str
1377
- :param _UrlExpireOn: 签署撤销url过期时间-年月日-时分秒
1394
+ :param _UrlExpireOn: 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
1395
+
1396
+
1378
1397
  :type UrlExpireOn: str
1379
1398
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1380
1399
  :type RequestId: str
@@ -4321,13 +4340,28 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4321
4340
 
4322
4341
  def __init__(self):
4323
4342
  r"""
4324
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
4343
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4344
+
4345
+ 此接口下面信息必填。
4346
+ <ul>
4347
+ <li>渠道应用标识: Agent.AppId</li>
4348
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4349
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4350
+ </ul>
4351
+ 第三方平台子客企业和员工必须已经经过实名认证
4325
4352
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4326
- :param _NeedRelievedFlowId: 待解除的流程编号(即原流程的编号)
4353
+ :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
4327
4354
  :type NeedRelievedFlowId: str
4328
- :param _ReliveInfo: 解除协议内容
4355
+ :param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
4329
4356
  :type ReliveInfo: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
4330
- :param _ReleasedApprovers: 非必须,解除协议的本企业签署人列表,默认使用原流程的签署人列表;当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业的其他签署人来替换原流程中的原签署人,注意需要指明ApproverNumber来代表需要替换哪一个签署人,已转发的签署人不包含在内,解除协议的签署人数量不能多于原流程的签署人数量
4357
+ :param _ReleasedApprovers: 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
4358
+ 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
4359
+
4360
+ 注意:
4361
+ <ul>
4362
+ <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
4363
+ <li>可以不指定替换签署人, 使用原流程的签署人</li>
4364
+ </ul>
4331
4365
  :type ReleasedApprovers: list of ReleasedApprover
4332
4366
  :param _CallbackUrl: 签署完回调url,最大长度1000个字符
4333
4367
  :type CallbackUrl: str
@@ -4335,8 +4369,15 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4335
4369
  :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
4336
4370
  :param _Operator: 暂未开放
4337
4371
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
4338
- :param _Deadline: 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
4372
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
4373
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
4339
4374
  :type Deadline: int
4375
+ :param _UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
4376
+
4377
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
4378
+
4379
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
4380
+ :type UserData: str
4340
4381
  """
4341
4382
  self._Agent = None
4342
4383
  self._NeedRelievedFlowId = None
@@ -4346,6 +4387,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4346
4387
  self._Organization = None
4347
4388
  self._Operator = None
4348
4389
  self._Deadline = None
4390
+ self._UserData = None
4349
4391
 
4350
4392
  @property
4351
4393
  def Agent(self):
@@ -4381,10 +4423,14 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4381
4423
 
4382
4424
  @property
4383
4425
  def CallbackUrl(self):
4426
+ warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
4427
+
4384
4428
  return self._CallbackUrl
4385
4429
 
4386
4430
  @CallbackUrl.setter
4387
4431
  def CallbackUrl(self, CallbackUrl):
4432
+ warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
4433
+
4388
4434
  self._CallbackUrl = CallbackUrl
4389
4435
 
4390
4436
  @property
@@ -4419,6 +4465,14 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4419
4465
  def Deadline(self, Deadline):
4420
4466
  self._Deadline = Deadline
4421
4467
 
4468
+ @property
4469
+ def UserData(self):
4470
+ return self._UserData
4471
+
4472
+ @UserData.setter
4473
+ def UserData(self, UserData):
4474
+ self._UserData = UserData
4475
+
4422
4476
 
4423
4477
  def _deserialize(self, params):
4424
4478
  if params.get("Agent") is not None:
@@ -4442,6 +4496,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
4442
4496
  self._Operator = UserInfo()
4443
4497
  self._Operator._deserialize(params.get("Operator"))
4444
4498
  self._Deadline = params.get("Deadline")
4499
+ self._UserData = params.get("UserData")
4445
4500
  memeber_set = set(params.keys())
4446
4501
  for name, value in vars(self).items():
4447
4502
  property_name = name[1:]
@@ -4743,22 +4798,29 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
4743
4798
 
4744
4799
  def __init__(self):
4745
4800
  r"""
4746
- :param _Agent: 渠道应用相关信息
4801
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4747
4802
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4748
- :param _SceneKey: 自动签场景:
4749
- E_PRESCRIPTION_AUTO_SIGN 电子处方
4803
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
4804
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4805
+
4806
+ 注: `现在仅支持电子处方场景`
4750
4807
  :type SceneKey: str
4751
- :param _Operator: 操作人信息
4808
+ :param _Operator: 执行本接口操作的员工信息。
4809
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4752
4810
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
4753
- :param _AutoSignConfig: 自动签开通,签署相关配置
4811
+ :param _AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
4754
4812
  :type AutoSignConfig: :class:`tencentcloud.essbasic.v20210526.models.AutoSignConfig`
4755
- :param _UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
4813
+ :param _UrlType: 生成的链接类型:
4814
+ <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
4815
+ <li> **H5SIGN** : 生成H5端开通链接</li></ul>
4756
4816
  :type UrlType: str
4757
- :param _NotifyType: 通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。
4817
+ :param _NotifyType: 是否通知开通方,通知类型:
4818
+ <ul><li>默认不设置为不通知开通方</li>
4819
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
4758
4820
  :type NotifyType: str
4759
- :param _NotifyAddress: 若上方填写为 SMS,则此处为手机号
4821
+ :param _NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
4760
4822
  :type NotifyAddress: str
4761
- :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。
4823
+ :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
4762
4824
  :type ExpiredTime: int
4763
4825
  """
4764
4826
  self._Agent = None
@@ -4867,17 +4929,27 @@ class ChannelCreateUserAutoSignEnableUrlResponse(AbstractModel):
4867
4929
 
4868
4930
  def __init__(self):
4869
4931
  r"""
4870
- :param _Url: 跳转短链
4932
+ :param _Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
4871
4933
  :type Url: str
4872
- :param _AppId: 小程序AppId
4934
+ :param _AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
4935
+
4936
+ 注: `如果获取的是H5链接, 则不会返回此值`
4873
4937
  :type AppId: str
4874
- :param _AppOriginalId: 小程序 原始 Id
4938
+ :param _AppOriginalId: 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
4939
+
4940
+ 注: `如果获取的是H5链接, 则不会返回此值`
4875
4941
  :type AppOriginalId: str
4876
- :param _Path: 跳转路径
4942
+ :param _Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
4943
+
4944
+ 注: `如果获取的是H5链接, 则不会返回此值`
4877
4945
  :type Path: str
4878
- :param _QrCode: base64格式跳转二维码
4946
+ :param _QrCode: base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
4947
+
4948
+ 注: `如果获取的是H5链接, 则不会返回此二维码图片`
4879
4949
  :type QrCode: str
4880
- :param _UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
4950
+ :param _UrlType: 返回的链接类型
4951
+ <ul><li> 空: 默认小程序端链接</li>
4952
+ <li> **H5SIGN** : h5端链接</li></ul>
4881
4953
  :type UrlType: str
4882
4954
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4883
4955
  :type RequestId: str
@@ -9982,21 +10054,20 @@ class DescribeTemplatesRequest(AbstractModel):
9982
10054
  第三方平台子客企业和员工必须已经经过实名认证
9983
10055
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9984
10056
  :param _TemplateId: 合同模板ID,为32位字符串。
9985
- 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
10057
+
10058
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
9986
10059
  :type TemplateId: str
9987
- :param _ContentType: 查询内容控制
10060
+ :param _ContentType: 查询模版的内容
9988
10061
 
9989
- <ul><li>**0**:模板列表及详情(默认)</li>
9990
- <li>**1**:仅模板列表</li></ul>
10062
+ <ul><li>**0**:(默认)模板列表及详情</li>
10063
+ <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
9991
10064
  :type ContentType: int
9992
- :param _TemplateIds: 合同模板ID数组,每一个合同模板ID为32位字符串。
9993
- 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
10065
+ :param _TemplateIds: 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
9994
10066
 
9995
- ```注意:
9996
- 1. 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。
9997
- 2. 请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。
9998
- 3. 最多支持200个模板。
9999
- 4. 若传递此参数,分页参数(Limit,Offset)无效```
10067
+ 注意:
10068
+ 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
10069
+ 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
10070
+ 4. `若传递此参数,分页参数(Limit,Offset)无效`
10000
10071
 
10001
10072
  :type TemplateIds: list of str
10002
10073
  :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用。
@@ -10008,31 +10079,32 @@ class DescribeTemplatesRequest(AbstractModel):
10008
10079
  注:`1.offset从0开始,即第一页为0。`
10009
10080
  `2.默认从第一页返回。`
10010
10081
  :type Offset: int
10011
- :param _TemplateName: 模糊搜索的模板名称,注意是模板名的连续部分,最大长度200
10082
+ :param _TemplateName: 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
10012
10083
  :type TemplateName: str
10013
10084
  :param _ChannelTemplateId: 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
10014
10085
  :type ChannelTemplateId: str
10015
- :param _QueryAllComponents: 是否返回所有控件信息。
10086
+ :param _QueryAllComponents: 返回控件的范围, 是只返回发起方自己的还是所有参与方的
10016
10087
 
10017
- <ul><li>**false**:只返回发起方控件(默认)</li>
10018
- <li>**true**:返回所有签署方控件</li></ul>
10088
+ <ul><li>**false**:(默认)只返回发起方控件</li>
10089
+ <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
10019
10090
  :type QueryAllComponents: bool
10020
10091
  :param _WithPreviewUrl: 是否获取模板预览链接。
10021
10092
 
10022
10093
  <ul><li>**false**:不获取(默认)</li>
10023
10094
  <li>**true**:获取</li></ul>
10024
10095
 
10025
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接,有效期5分钟。
10026
- 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
10027
- (此功能开放需要联系客户经理)
10096
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
10097
+
10098
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
10028
10099
  :type WithPreviewUrl: bool
10029
10100
  :param _WithPdfUrl: 是否获取模板的PDF文件链接。
10030
10101
 
10031
10102
  <ul><li>**false**:不获取(默认)</li>
10032
10103
  <li>**true**:获取</li></ul>
10033
10104
 
10034
- 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟。
10035
- (此功能开放需要联系客户经理)
10105
+ 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
10106
+
10107
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
10036
10108
  :type WithPdfUrl: bool
10037
10109
  :param _Operator: 操作者的信息
10038
10110
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -14137,22 +14209,22 @@ class ProxyOrganizationOperator(AbstractModel):
14137
14209
 
14138
14210
 
14139
14211
  class Recipient(AbstractModel):
14140
- """流程中参与方的信息结构
14212
+ """流程中签署方和填写方(如果有填写控件存证时)的信息
14141
14213
 
14142
14214
  """
14143
14215
 
14144
14216
  def __init__(self):
14145
14217
  r"""
14146
- :param _RecipientId: 签署人唯一标识,在通过模板发起合同的时候对应签署方ID
14218
+ :param _RecipientId: 合同参与方的角色ID
14147
14219
  :type RecipientId: str
14148
- :param _RecipientType: 参与者类型,默认为空。
14149
- ENTERPRISE-企业;
14150
- INDIVIDUAL-个人;
14151
- PROMOTER-发起方
14220
+ :param _RecipientType: 参与者类型, 可以选择的类型如下:
14221
+ <ul><li> **ENTERPRISE** :此角色为企业参与方</li>
14222
+ <li> **INDIVIDUAL** :此角色为个人参与方</li>
14223
+ <li> **PROMOTER** :此角色是发起方</li></ul>
14152
14224
  :type RecipientType: str
14153
- :param _Description: 描述信息
14225
+ :param _Description: 合同参与方的角色描述,长度不能超过100,只能由中文、字母、数字和下划线组成。
14154
14226
  :type Description: str
14155
- :param _RoleName: 角色名称
14227
+ :param _RoleName: 合同参与方的角色名字,长度不能超过20,只能由中文、字母、数字和下划线组成。
14156
14228
  :type RoleName: str
14157
14229
  :param _RequireValidation: 是否需要校验,
14158
14230
  true-是,
@@ -1088,13 +1088,14 @@ class MergeInfo(AbstractModel):
1088
1088
 
1089
1089
  def __init__(self):
1090
1090
  r"""
1091
- :param _Image: 输入图片base64
1091
+ :param _Image: 输入图片base64
1092
1092
  :type Image: str
1093
- :param _Url: 输入图片url
1093
+ :param _Url: 输入图片url
1094
+ Url、Image必须提供一个,如果都提供,只使用 Url。
1094
1095
  :type Url: str
1095
- :param _InputImageFaceRect: 上传的图片人脸位置信息(人脸框)
1096
+ :param _InputImageFaceRect: 输入图片人脸位置信息(人脸框)。不填默认取输入图中最大人脸。
1096
1097
  :type InputImageFaceRect: :class:`tencentcloud.facefusion.v20181201.models.FaceRect`
1097
- :param _TemplateFaceID: 控制台上传的素材人脸ID,不填默认取最大人脸
1098
+ :param _TemplateFaceID: 素材人脸ID,不填默认取素材中最大人脸。
1098
1099
  :type TemplateFaceID: str
1099
1100
  """
1100
1101
  self._Image = None
@@ -13468,6 +13468,177 @@ class DescribeSubscriptionsResponse(AbstractModel):
13468
13468
  self._RequestId = params.get("RequestId")
13469
13469
 
13470
13470
 
13471
+ class DescribeTopicMsgsRequest(AbstractModel):
13472
+ """DescribeTopicMsgs请求参数结构体
13473
+
13474
+ """
13475
+
13476
+ def __init__(self):
13477
+ r"""
13478
+ :param _EnvironmentId: 环境(命名空间)名称。
13479
+ :type EnvironmentId: str
13480
+ :param _TopicName: 主题名。
13481
+ :type TopicName: str
13482
+ :param _StartTime: 开始时间。
13483
+ :type StartTime: str
13484
+ :param _EndTime: 结束时间。
13485
+ :type EndTime: str
13486
+ :param _Offset: 起始下标,不填默认为0。
13487
+ :type Offset: int
13488
+ :param _Limit: 返回数量,不填则默认为10,最大值为20。
13489
+ :type Limit: int
13490
+ :param _MsgId: 消息ID。
13491
+ :type MsgId: str
13492
+ :param _ClusterId: Pulsar 集群的ID
13493
+ :type ClusterId: str
13494
+ """
13495
+ self._EnvironmentId = None
13496
+ self._TopicName = None
13497
+ self._StartTime = None
13498
+ self._EndTime = None
13499
+ self._Offset = None
13500
+ self._Limit = None
13501
+ self._MsgId = None
13502
+ self._ClusterId = None
13503
+
13504
+ @property
13505
+ def EnvironmentId(self):
13506
+ return self._EnvironmentId
13507
+
13508
+ @EnvironmentId.setter
13509
+ def EnvironmentId(self, EnvironmentId):
13510
+ self._EnvironmentId = EnvironmentId
13511
+
13512
+ @property
13513
+ def TopicName(self):
13514
+ return self._TopicName
13515
+
13516
+ @TopicName.setter
13517
+ def TopicName(self, TopicName):
13518
+ self._TopicName = TopicName
13519
+
13520
+ @property
13521
+ def StartTime(self):
13522
+ return self._StartTime
13523
+
13524
+ @StartTime.setter
13525
+ def StartTime(self, StartTime):
13526
+ self._StartTime = StartTime
13527
+
13528
+ @property
13529
+ def EndTime(self):
13530
+ return self._EndTime
13531
+
13532
+ @EndTime.setter
13533
+ def EndTime(self, EndTime):
13534
+ self._EndTime = EndTime
13535
+
13536
+ @property
13537
+ def Offset(self):
13538
+ return self._Offset
13539
+
13540
+ @Offset.setter
13541
+ def Offset(self, Offset):
13542
+ self._Offset = Offset
13543
+
13544
+ @property
13545
+ def Limit(self):
13546
+ return self._Limit
13547
+
13548
+ @Limit.setter
13549
+ def Limit(self, Limit):
13550
+ self._Limit = Limit
13551
+
13552
+ @property
13553
+ def MsgId(self):
13554
+ return self._MsgId
13555
+
13556
+ @MsgId.setter
13557
+ def MsgId(self, MsgId):
13558
+ self._MsgId = MsgId
13559
+
13560
+ @property
13561
+ def ClusterId(self):
13562
+ return self._ClusterId
13563
+
13564
+ @ClusterId.setter
13565
+ def ClusterId(self, ClusterId):
13566
+ self._ClusterId = ClusterId
13567
+
13568
+
13569
+ def _deserialize(self, params):
13570
+ self._EnvironmentId = params.get("EnvironmentId")
13571
+ self._TopicName = params.get("TopicName")
13572
+ self._StartTime = params.get("StartTime")
13573
+ self._EndTime = params.get("EndTime")
13574
+ self._Offset = params.get("Offset")
13575
+ self._Limit = params.get("Limit")
13576
+ self._MsgId = params.get("MsgId")
13577
+ self._ClusterId = params.get("ClusterId")
13578
+ memeber_set = set(params.keys())
13579
+ for name, value in vars(self).items():
13580
+ property_name = name[1:]
13581
+ if property_name in memeber_set:
13582
+ memeber_set.remove(property_name)
13583
+ if len(memeber_set) > 0:
13584
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
13585
+
13586
+
13587
+
13588
+ class DescribeTopicMsgsResponse(AbstractModel):
13589
+ """DescribeTopicMsgs返回参数结构体
13590
+
13591
+ """
13592
+
13593
+ def __init__(self):
13594
+ r"""
13595
+ :param _TotalCount: 总记录数。
13596
+ :type TotalCount: int
13597
+ :param _TopicMsgLogSets: 消息日志列表。
13598
+ :type TopicMsgLogSets: list of MsgLog
13599
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
13600
+ :type RequestId: str
13601
+ """
13602
+ self._TotalCount = None
13603
+ self._TopicMsgLogSets = None
13604
+ self._RequestId = None
13605
+
13606
+ @property
13607
+ def TotalCount(self):
13608
+ return self._TotalCount
13609
+
13610
+ @TotalCount.setter
13611
+ def TotalCount(self, TotalCount):
13612
+ self._TotalCount = TotalCount
13613
+
13614
+ @property
13615
+ def TopicMsgLogSets(self):
13616
+ return self._TopicMsgLogSets
13617
+
13618
+ @TopicMsgLogSets.setter
13619
+ def TopicMsgLogSets(self, TopicMsgLogSets):
13620
+ self._TopicMsgLogSets = TopicMsgLogSets
13621
+
13622
+ @property
13623
+ def RequestId(self):
13624
+ return self._RequestId
13625
+
13626
+ @RequestId.setter
13627
+ def RequestId(self, RequestId):
13628
+ self._RequestId = RequestId
13629
+
13630
+
13631
+ def _deserialize(self, params):
13632
+ self._TotalCount = params.get("TotalCount")
13633
+ if params.get("TopicMsgLogSets") is not None:
13634
+ self._TopicMsgLogSets = []
13635
+ for item in params.get("TopicMsgLogSets"):
13636
+ obj = MsgLog()
13637
+ obj._deserialize(item)
13638
+ self._TopicMsgLogSets.append(obj)
13639
+ self._RequestId = params.get("RequestId")
13640
+
13641
+
13471
13642
  class DescribeTopicsRequest(AbstractModel):
13472
13643
  """DescribeTopics请求参数结构体
13473
13644
 
@@ -16889,6 +17060,75 @@ class ModifyTopicResponse(AbstractModel):
16889
17060
  self._RequestId = params.get("RequestId")
16890
17061
 
16891
17062
 
17063
+ class MsgLog(AbstractModel):
17064
+ """消息日志
17065
+
17066
+ """
17067
+
17068
+ def __init__(self):
17069
+ r"""
17070
+ :param _MsgId: 消息ID。
17071
+ :type MsgId: str
17072
+ :param _ProducerName: 生产者名称。
17073
+ :type ProducerName: str
17074
+ :param _ProduceTime: 生产时间。
17075
+ :type ProduceTime: str
17076
+ :param _ProducerAddr: 生产客户端地址。
17077
+ :type ProducerAddr: str
17078
+ """
17079
+ self._MsgId = None
17080
+ self._ProducerName = None
17081
+ self._ProduceTime = None
17082
+ self._ProducerAddr = None
17083
+
17084
+ @property
17085
+ def MsgId(self):
17086
+ return self._MsgId
17087
+
17088
+ @MsgId.setter
17089
+ def MsgId(self, MsgId):
17090
+ self._MsgId = MsgId
17091
+
17092
+ @property
17093
+ def ProducerName(self):
17094
+ return self._ProducerName
17095
+
17096
+ @ProducerName.setter
17097
+ def ProducerName(self, ProducerName):
17098
+ self._ProducerName = ProducerName
17099
+
17100
+ @property
17101
+ def ProduceTime(self):
17102
+ return self._ProduceTime
17103
+
17104
+ @ProduceTime.setter
17105
+ def ProduceTime(self, ProduceTime):
17106
+ self._ProduceTime = ProduceTime
17107
+
17108
+ @property
17109
+ def ProducerAddr(self):
17110
+ return self._ProducerAddr
17111
+
17112
+ @ProducerAddr.setter
17113
+ def ProducerAddr(self, ProducerAddr):
17114
+ self._ProducerAddr = ProducerAddr
17115
+
17116
+
17117
+ def _deserialize(self, params):
17118
+ self._MsgId = params.get("MsgId")
17119
+ self._ProducerName = params.get("ProducerName")
17120
+ self._ProduceTime = params.get("ProduceTime")
17121
+ self._ProducerAddr = params.get("ProducerAddr")
17122
+ memeber_set = set(params.keys())
17123
+ for name, value in vars(self).items():
17124
+ property_name = name[1:]
17125
+ if property_name in memeber_set:
17126
+ memeber_set.remove(property_name)
17127
+ if len(memeber_set) > 0:
17128
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
17129
+
17130
+
17131
+
16892
17132
  class PartitionsTopic(AbstractModel):
16893
17133
  """分区topic
16894
17134