tencentcloud-sdk-python 3.0.973__py2.py3-none-any.whl → 3.0.975__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 (58) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/asr/v20190614/asr_client.py +11 -10
  3. tencentcloud/asr/v20190614/models.py +49 -18
  4. tencentcloud/ccc/v20200210/models.py +2 -2
  5. tencentcloud/cdb/v20170320/errorcodes.py +6 -0
  6. tencentcloud/cdwch/v20200915/models.py +201 -0
  7. tencentcloud/cfw/v20190904/cfw_client.py +47 -0
  8. tencentcloud/cfw/v20190904/models.py +322 -11
  9. tencentcloud/ckafka/v20190819/models.py +2 -2
  10. tencentcloud/clb/v20180317/models.py +75 -5
  11. tencentcloud/cls/v20201016/models.py +26 -0
  12. tencentcloud/cvm/v20170312/cvm_client.py +1 -0
  13. tencentcloud/cvm/v20170312/models.py +1 -13
  14. tencentcloud/cynosdb/v20190107/models.py +9 -6
  15. tencentcloud/dbbrain/v20210527/dbbrain_client.py +46 -0
  16. tencentcloud/dbbrain/v20210527/models.py +867 -0
  17. tencentcloud/dnspod/v20210323/errorcodes.py +7 -7
  18. tencentcloud/dnspod/v20210323/models.py +13 -1
  19. tencentcloud/ecm/v20190719/models.py +15 -2
  20. tencentcloud/eis/v20210601/errorcodes.py +3 -0
  21. tencentcloud/emr/v20190103/errorcodes.py +3 -0
  22. tencentcloud/ess/v20201111/ess_client.py +25 -13
  23. tencentcloud/ess/v20201111/models.py +162 -120
  24. tencentcloud/essbasic/v20210526/essbasic_client.py +7 -0
  25. tencentcloud/essbasic/v20210526/models.py +22 -15
  26. tencentcloud/faceid/v20180301/models.py +17 -1
  27. tencentcloud/iotexplorer/v20190423/errorcodes.py +1 -1
  28. tencentcloud/lcic/v20220817/errorcodes.py +3 -0
  29. tencentcloud/lcic/v20220817/models.py +74 -0
  30. tencentcloud/live/v20180801/live_client.py +23 -0
  31. tencentcloud/live/v20180801/models.py +131 -0
  32. tencentcloud/monitor/v20180724/models.py +182 -2
  33. tencentcloud/monitor/v20180724/monitor_client.py +23 -0
  34. tencentcloud/mps/v20190612/models.py +304 -0
  35. tencentcloud/oceanus/v20190422/models.py +15 -1
  36. tencentcloud/ses/v20201002/models.py +1 -1
  37. tencentcloud/sqlserver/v20180328/models.py +3 -3
  38. tencentcloud/sqlserver/v20180328/sqlserver_client.py +0 -1
  39. tencentcloud/ssl/v20191205/models.py +1836 -50
  40. tencentcloud/ssl/v20191205/ssl_client.py +69 -0
  41. tencentcloud/tdmq/v20200217/models.py +587 -1
  42. tencentcloud/tdmq/v20200217/tdmq_client.py +46 -0
  43. tencentcloud/tem/v20210701/errorcodes.py +3 -0
  44. tencentcloud/teo/v20220901/errorcodes.py +21 -0
  45. tencentcloud/teo/v20220901/models.py +96 -0
  46. tencentcloud/teo/v20220901/teo_client.py +23 -0
  47. tencentcloud/tione/v20211111/models.py +121 -0
  48. tencentcloud/trtc/v20190722/models.py +5 -2
  49. tencentcloud/tse/v20201207/models.py +13 -0
  50. tencentcloud/tsf/v20180326/models.py +5 -4
  51. tencentcloud/tsf/v20180326/tsf_client.py +1 -1
  52. tencentcloud/vod/v20180717/models.py +1 -1
  53. tencentcloud/vpc/v20170312/errorcodes.py +3 -0
  54. {tencentcloud_sdk_python-3.0.973.dist-info → tencentcloud_sdk_python-3.0.975.dist-info}/METADATA +1 -1
  55. {tencentcloud_sdk_python-3.0.973.dist-info → tencentcloud_sdk_python-3.0.975.dist-info}/RECORD +58 -58
  56. {tencentcloud_sdk_python-3.0.973.dist-info → tencentcloud_sdk_python-3.0.975.dist-info}/LICENSE +0 -0
  57. {tencentcloud_sdk_python-3.0.973.dist-info → tencentcloud_sdk_python-3.0.975.dist-info}/WHEEL +0 -0
  58. {tencentcloud_sdk_python-3.0.973.dist-info → tencentcloud_sdk_python-3.0.975.dist-info}/top_level.txt +0 -0
@@ -843,19 +843,19 @@ class BindEmployeeUserIdWithClientOpenIdResponse(AbstractModel):
843
843
 
844
844
 
845
845
  class CallbackInfo(AbstractModel):
846
- """应用回调信息
846
+ """企业应用回调信息
847
847
 
848
848
  """
849
849
 
850
850
  def __init__(self):
851
851
  r"""
852
- :param _CallbackUrl: 回调url
852
+ :param _CallbackUrl: 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
853
853
  :type CallbackUrl: str
854
854
  :param _Token: 回调加密key,已废弃
855
855
  :type Token: str
856
- :param _CallbackKey: 回调加密key
856
+ :param _CallbackKey: 回调加密key,用于回调消息加解密。
857
857
  :type CallbackKey: str
858
- :param _CallbackToken: 回调验签token
858
+ :param _CallbackToken: 回调验签token,用于回调通知校验。
859
859
  :type CallbackToken: str
860
860
  """
861
861
  self._CallbackUrl = None
@@ -4874,33 +4874,39 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4874
4874
 
4875
4875
  def __init__(self):
4876
4876
  r"""
4877
- :param _Operator: 用户信息,其中UserId为必填参数
4877
+ :param _Operator: 执行本接口操作的员工信息。
4878
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4878
4879
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
4879
- :param _TemplateId: 模板ID
4880
+ :param _TemplateId: 合同模板ID,为32位字符串。
4881
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
4880
4882
  :type TemplateId: str
4881
- :param _FlowName: 签署流程名称,最大长度不超过200字符
4883
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
4884
+ 该名称还将用于合同签署完成后的下载文件名。
4882
4885
  :type FlowName: str
4883
- :param _MaxFlowNum: 最大可发起签署流程份数,默认5
4884
- <br/>发起流程数量超过此上限后二维码自动失效
4886
+ :param _MaxFlowNum: 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
4887
+ 一旦发起流程数超越该限制,该二维码将自动失效。
4885
4888
  :type MaxFlowNum: int
4886
- :param _FlowEffectiveDay: 签署流程有效天数
4887
- <br/>默认7天
4888
- <br/>最高设置不超过30天
4889
- :type FlowEffectiveDay: int
4890
- :param _QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
4889
+ :param _QrEffectiveDay: 二维码的有效期限,默认为7天,最高设定不得超过90天。
4890
+ 一旦超过二维码的有效期限,该二维码将自动失效。
4891
4891
  :type QrEffectiveDay: int
4892
- :param _Restrictions: 指定的签署人信息
4893
- <br/>指定后,则只允许指定的签署人扫码签署
4892
+ :param _FlowEffectiveDay: 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
4893
+ 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
4894
+ 最长设定期限不得超过30天。
4895
+ :type FlowEffectiveDay: int
4896
+ :param _Restrictions: 指定签署人信息。
4897
+ 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
4894
4898
  :type Restrictions: list of ApproverRestriction
4895
- :param _UserData: 用户自定义字段
4896
- <br/>回调的时候会进行透传,长度需要小于20480
4899
+ :param _UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
4900
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
4901
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
4897
4902
  :type UserData: str
4898
4903
  :param _CallbackUrl: 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
4899
4904
  <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
4900
4905
  <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
4901
4906
 
4902
4907
  :type CallbackUrl: str
4903
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4908
+ :param _Agent: 代理企业和员工的信息。
4909
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4904
4910
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
4905
4911
  :param _ApproverRestrictions: 限制二维码用户条件(已弃用)
4906
4912
  :type ApproverRestrictions: :class:`tencentcloud.ess.v20201111.models.ApproverRestriction`
@@ -4909,8 +4915,8 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4909
4915
  self._TemplateId = None
4910
4916
  self._FlowName = None
4911
4917
  self._MaxFlowNum = None
4912
- self._FlowEffectiveDay = None
4913
4918
  self._QrEffectiveDay = None
4919
+ self._FlowEffectiveDay = None
4914
4920
  self._Restrictions = None
4915
4921
  self._UserData = None
4916
4922
  self._CallbackUrl = None
@@ -4949,14 +4955,6 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4949
4955
  def MaxFlowNum(self, MaxFlowNum):
4950
4956
  self._MaxFlowNum = MaxFlowNum
4951
4957
 
4952
- @property
4953
- def FlowEffectiveDay(self):
4954
- return self._FlowEffectiveDay
4955
-
4956
- @FlowEffectiveDay.setter
4957
- def FlowEffectiveDay(self, FlowEffectiveDay):
4958
- self._FlowEffectiveDay = FlowEffectiveDay
4959
-
4960
4958
  @property
4961
4959
  def QrEffectiveDay(self):
4962
4960
  return self._QrEffectiveDay
@@ -4965,6 +4963,14 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4965
4963
  def QrEffectiveDay(self, QrEffectiveDay):
4966
4964
  self._QrEffectiveDay = QrEffectiveDay
4967
4965
 
4966
+ @property
4967
+ def FlowEffectiveDay(self):
4968
+ return self._FlowEffectiveDay
4969
+
4970
+ @FlowEffectiveDay.setter
4971
+ def FlowEffectiveDay(self, FlowEffectiveDay):
4972
+ self._FlowEffectiveDay = FlowEffectiveDay
4973
+
4968
4974
  @property
4969
4975
  def Restrictions(self):
4970
4976
  return self._Restrictions
@@ -5021,8 +5027,8 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
5021
5027
  self._TemplateId = params.get("TemplateId")
5022
5028
  self._FlowName = params.get("FlowName")
5023
5029
  self._MaxFlowNum = params.get("MaxFlowNum")
5024
- self._FlowEffectiveDay = params.get("FlowEffectiveDay")
5025
5030
  self._QrEffectiveDay = params.get("QrEffectiveDay")
5031
+ self._FlowEffectiveDay = params.get("FlowEffectiveDay")
5026
5032
  if params.get("Restrictions") is not None:
5027
5033
  self._Restrictions = []
5028
5034
  for item in params.get("Restrictions"):
@@ -5054,9 +5060,9 @@ class CreateMultiFlowSignQRCodeResponse(AbstractModel):
5054
5060
 
5055
5061
  def __init__(self):
5056
5062
  r"""
5057
- :param _QrCode: 签署二维码对象
5063
+ :param _QrCode: 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
5058
5064
  :type QrCode: :class:`tencentcloud.ess.v20201111.models.SignQrCode`
5059
- :param _SignUrls: 签署链接对象
5065
+ :param _SignUrls: 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
5060
5066
  :type SignUrls: :class:`tencentcloud.ess.v20201111.models.SignUrl`
5061
5067
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5062
5068
  :type RequestId: str
@@ -6125,45 +6131,49 @@ class CreateSchemeUrlRequest(AbstractModel):
6125
6131
 
6126
6132
  def __init__(self):
6127
6133
  r"""
6128
- :param _Operator: 调用方用户信息,userId 必填
6134
+ :param _Operator: 执行本接口操作的员工信息, userId 必填。
6135
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6129
6136
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
6130
- :param _OrganizationName: 企业名称
6137
+ :param _OrganizationName: 合同流程签署方的组织机构名称。
6138
+ 如果名称中包含英文括号(),请使用中文括号()代替。
6131
6139
  :type OrganizationName: str
6132
- :param _Name: 姓名,最大长度50个字符
6140
+ :param _Name: 合同流程里边签署方经办人的姓名。
6141
+
6133
6142
  :type Name: str
6134
- :param _Mobile: 手机号,大陆手机号11
6143
+ :param _Mobile: 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
6135
6144
  :type Mobile: str
6136
6145
  :param _EndPoint: 要跳转的链接类型
6137
6146
 
6138
- - HTTP:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认),此时返回长链
6139
- - HTTP_SHORT_URL:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
6140
- - APP 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
6141
-
6147
+ <ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li>
6148
+ <li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li>
6149
+ <li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
6142
6150
  :type EndPoint: str
6143
- :param _FlowId: 签署流程编号 (PathType=1时必传)
6151
+ :param _FlowId: 合同流程ID
6152
+ 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
6144
6153
  :type FlowId: str
6145
- :param _FlowGroupId: 合同组ID
6154
+ :param _FlowGroupId: 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
6146
6155
  :type FlowGroupId: str
6147
6156
  :param _PathType: 要跳转到的页面类型
6148
6157
 
6149
- - 0: 不传, 主页 (默认)
6150
- - 1: 小程序合同详情
6151
- - 2: 小程序合同列表页
6152
-
6158
+ <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
6159
+ <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
6160
+ <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
6153
6161
  :type PathType: int
6154
- :param _AutoJumpBack: 是否自动回跳
6155
- true:是,
6156
- false:否。
6157
- 该参数只针对"APP" 类型的签署链接有效
6162
+ :param _AutoJumpBack: 签署完成后是否自动回跳
6163
+ <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
6164
+ 注: ` 该参数只针对"APP" 类型的签署链接有效`
6158
6165
  :type AutoJumpBack: bool
6159
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
6166
+ :param _Agent: 代理企业和员工的信息。
6167
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6160
6168
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6161
- :param _Hides: 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
6169
+ :param _Hides: 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
6170
+
6171
+ <ul><li> **0** :合同签署页面更多操作按钮</li>
6172
+ <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
6173
+ <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
6174
+ <li> **3** :签署成功页的查看详情按钮</li></ul>
6162
6175
 
6163
- - 0:合同签署页面更多操作按钮
6164
- - 1:合同签署页面更多操作的拒绝签署按钮
6165
- - 2:合同签署页面更多操作的转他人处理按钮
6166
- - 3:签署成功页的查看详情按钮
6176
+ 注: `字段为数组, 可以传值隐藏多个按钮`
6167
6177
  :type Hides: list of int
6168
6178
  """
6169
6179
  self._Operator = None
@@ -6300,7 +6310,11 @@ class CreateSchemeUrlResponse(AbstractModel):
6300
6310
 
6301
6311
  def __init__(self):
6302
6312
  r"""
6303
- :param _SchemeUrl: 小程序链接地址,有效期90天。如果EndPoint是App,得到的链接Path如’weixin://dl/business/?t= *TICKET*‘,用于客户APP、小程序直接拉起电子签小程序;其他EndPoint得到的https链接如'https://essurl.cn/xxx',点击链接会打开一个H5页面,然后拉起电子签小程序。
6313
+ :param _SchemeUrl: 腾讯电子签小程序的签署链接。
6314
+
6315
+ <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
6316
+ <li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
6317
+ <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
6304
6318
  :type SchemeUrl: str
6305
6319
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6306
6320
  :type RequestId: str
@@ -7680,21 +7694,25 @@ class DescribeExtendedServiceAuthInfosRequest(AbstractModel):
7680
7694
 
7681
7695
  def __init__(self):
7682
7696
  r"""
7683
- :param _Operator: 操作人信息
7697
+ :param _Operator: 执行本接口操作的员工信息。
7698
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
7684
7699
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
7685
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作
7686
- :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
7687
- :param _ExtendServiceType: 扩展服务类型,默认为空,查询目前支持的所有扩展服务信息,单个指定则查询单个扩展服务开通信息,取值:
7688
- OPEN_SERVER_SIGN:开通企业静默签署
7689
- OVERSEA_SIGN:企业与港澳台居民签署合同
7690
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
7691
- PAGING_SEAL:骑缝章
7692
- BATCH_SIGN:批量签署
7700
+ :param _ExtendServiceType: 要查询的扩展服务类型。
7701
+ 默认为空,即查询当前支持的所有扩展服务信息。
7702
+ 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
7703
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
7704
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
7705
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
7706
+ <li>PAGING_SEAL:骑缝章</li>
7707
+ <li>BATCH_SIGN:批量签署</li></ul>
7693
7708
  :type ExtendServiceType: str
7709
+ :param _Agent: 代理企业和员工的信息。
7710
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
7711
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
7694
7712
  """
7695
7713
  self._Operator = None
7696
- self._Agent = None
7697
7714
  self._ExtendServiceType = None
7715
+ self._Agent = None
7698
7716
 
7699
7717
  @property
7700
7718
  def Operator(self):
@@ -7704,14 +7722,6 @@ BATCH_SIGN:批量签署
7704
7722
  def Operator(self, Operator):
7705
7723
  self._Operator = Operator
7706
7724
 
7707
- @property
7708
- def Agent(self):
7709
- return self._Agent
7710
-
7711
- @Agent.setter
7712
- def Agent(self, Agent):
7713
- self._Agent = Agent
7714
-
7715
7725
  @property
7716
7726
  def ExtendServiceType(self):
7717
7727
  return self._ExtendServiceType
@@ -7720,15 +7730,23 @@ BATCH_SIGN:批量签署
7720
7730
  def ExtendServiceType(self, ExtendServiceType):
7721
7731
  self._ExtendServiceType = ExtendServiceType
7722
7732
 
7733
+ @property
7734
+ def Agent(self):
7735
+ return self._Agent
7736
+
7737
+ @Agent.setter
7738
+ def Agent(self, Agent):
7739
+ self._Agent = Agent
7740
+
7723
7741
 
7724
7742
  def _deserialize(self, params):
7725
7743
  if params.get("Operator") is not None:
7726
7744
  self._Operator = UserInfo()
7727
7745
  self._Operator._deserialize(params.get("Operator"))
7746
+ self._ExtendServiceType = params.get("ExtendServiceType")
7728
7747
  if params.get("Agent") is not None:
7729
7748
  self._Agent = Agent()
7730
7749
  self._Agent._deserialize(params.get("Agent"))
7731
- self._ExtendServiceType = params.get("ExtendServiceType")
7732
7750
  memeber_set = set(params.keys())
7733
7751
  for name, value in vars(self).items():
7734
7752
  property_name = name[1:]
@@ -7746,7 +7764,7 @@ class DescribeExtendedServiceAuthInfosResponse(AbstractModel):
7746
7764
 
7747
7765
  def __init__(self):
7748
7766
  r"""
7749
- :param _AuthInfoList: 授权服务信息列表
7767
+ :param _AuthInfoList: 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
7750
7768
  :type AuthInfoList: list of ExtendAuthInfo
7751
7769
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7752
7770
  :type RequestId: str
@@ -10063,31 +10081,32 @@ class EmbedUrlOption(AbstractModel):
10063
10081
 
10064
10082
 
10065
10083
  class ExtendAuthInfo(AbstractModel):
10066
- """授权服务信息
10084
+ """扩展服务开通和授权的详细信息
10067
10085
 
10068
10086
  """
10069
10087
 
10070
10088
  def __init__(self):
10071
10089
  r"""
10072
- :param _Type: 授权服务类型
10073
- OPEN_SERVER_SIGN:开通企业静默签署
10074
- OVERSEA_SIGN:企业与港澳台居民签署合同
10075
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
10076
- PAGING_SEAL:骑缝章
10077
- BATCH_SIGN:批量签署
10090
+ :param _Type: 扩展服务的类型,可能是以下值:
10091
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
10092
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
10093
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
10094
+ <li>PAGING_SEAL:骑缝章</li>
10095
+ <li>BATCH_SIGN:批量签署</li></ul>
10078
10096
  :type Type: str
10079
- :param _Name: 授权服务名称
10097
+ :param _Name: 扩展服务的名称
10080
10098
  :type Name: str
10081
- :param _Status: 授权服务状态,ENABLE:开通
10099
+ :param _Status: 扩展服务的开通状态:
10100
+ ENABLE:开通
10082
10101
  DISABLE:未开通
10083
10102
  :type Status: str
10084
- :param _OperatorUserId: 授权人用户id
10103
+ :param _OperatorUserId: 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
10085
10104
  注意:此字段可能返回 null,表示取不到有效值。
10086
10105
  :type OperatorUserId: str
10087
- :param _OperateOn: 授权时间戳,单位秒
10106
+ :param _OperateOn: 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
10088
10107
  注意:此字段可能返回 null,表示取不到有效值。
10089
10108
  :type OperateOn: int
10090
- :param _HasAuthUserList: 被授权用户列表
10109
+ :param _HasAuthUserList: 该扩展服务若可以授权,此参数对应授权人员的列表
10091
10110
  注意:此字段可能返回 null,表示取不到有效值。
10092
10111
  :type HasAuthUserList: list of HasAuthUser
10093
10112
  """
@@ -10824,6 +10843,9 @@ class FlowApproverDetail(AbstractModel):
10824
10843
  :param _OrganizationName: 签署方企业名称
10825
10844
  注意:此字段可能返回 null,表示取不到有效值。
10826
10845
  :type OrganizationName: str
10846
+ :param _SignId: 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
10847
+ 注意:此字段可能返回 null,表示取不到有效值。
10848
+ :type SignId: str
10827
10849
  """
10828
10850
  self._ApproveMessage = None
10829
10851
  self._ApproveName = None
@@ -10838,6 +10860,7 @@ class FlowApproverDetail(AbstractModel):
10838
10860
  self._CustomApproverTag = None
10839
10861
  self._OrganizationId = None
10840
10862
  self._OrganizationName = None
10863
+ self._SignId = None
10841
10864
 
10842
10865
  @property
10843
10866
  def ApproveMessage(self):
@@ -10943,6 +10966,14 @@ class FlowApproverDetail(AbstractModel):
10943
10966
  def OrganizationName(self, OrganizationName):
10944
10967
  self._OrganizationName = OrganizationName
10945
10968
 
10969
+ @property
10970
+ def SignId(self):
10971
+ return self._SignId
10972
+
10973
+ @SignId.setter
10974
+ def SignId(self, SignId):
10975
+ self._SignId = SignId
10976
+
10946
10977
 
10947
10978
  def _deserialize(self, params):
10948
10979
  self._ApproveMessage = params.get("ApproveMessage")
@@ -10958,6 +10989,7 @@ class FlowApproverDetail(AbstractModel):
10958
10989
  self._CustomApproverTag = params.get("CustomApproverTag")
10959
10990
  self._OrganizationId = params.get("OrganizationId")
10960
10991
  self._OrganizationName = params.get("OrganizationName")
10992
+ self._SignId = params.get("SignId")
10961
10993
  memeber_set = set(params.keys())
10962
10994
  for name, value in vars(self).items():
10963
10995
  property_name = name[1:]
@@ -12585,18 +12617,18 @@ class GroupOrganization(AbstractModel):
12585
12617
 
12586
12618
 
12587
12619
  class HasAuthUser(AbstractModel):
12588
- """被授权用户信息
12620
+ """被授权的用户信息
12589
12621
 
12590
12622
  """
12591
12623
 
12592
12624
  def __init__(self):
12593
12625
  r"""
12594
- :param _UserId: 用户id
12626
+ :param _UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
12595
12627
  注意:此字段可能返回 null,表示取不到有效值。
12596
12628
  :type UserId: str
12597
- :param _BelongTo: 用户归属
12598
- MainOrg:主企业
12599
- CurrentOrg:当前企业
12629
+ :param _BelongTo: 当前员工的归属情况,可能值是:
12630
+ MainOrg:在集团企业的场景下,返回此值代表是归属主企业
12631
+ CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
12600
12632
  注意:此字段可能返回 null,表示取不到有效值。
12601
12633
  :type BelongTo: str
12602
12634
  """
@@ -12890,13 +12922,17 @@ class ModifyApplicationCallbackInfoRequest(AbstractModel):
12890
12922
 
12891
12923
  def __init__(self):
12892
12924
  r"""
12893
- :param _Operator: 调用方用户信息,userId 必填
12925
+ :param _Operator: 执行本接口操作的员工信息。
12926
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
12894
12927
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
12895
- :param _OperateType: 操作类型:1-新增,2-删除
12928
+ :param _OperateType: 操作类型:
12929
+ 1-新增
12930
+ 2-删除
12896
12931
  :type OperateType: int
12897
- :param _CallbackInfo: 回调信息
12932
+ :param _CallbackInfo: 企业应用回调信息
12898
12933
  :type CallbackInfo: :class:`tencentcloud.ess.v20201111.models.CallbackInfo`
12899
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
12934
+ :param _Agent: 代理企业和员工的信息。
12935
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12900
12936
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
12901
12937
  """
12902
12938
  self._Operator = None
@@ -14641,17 +14677,18 @@ CONTRACT:合同专用章
14641
14677
 
14642
14678
 
14643
14679
  class SignQrCode(AbstractModel):
14644
- """一码多扫签署二维码对象
14680
+ """签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
14645
14681
 
14646
14682
  """
14647
14683
 
14648
14684
  def __init__(self):
14649
14685
  r"""
14650
- :param _QrCodeId: 二维码id
14686
+ :param _QrCodeId: 二维码ID,为32位字符串。
14651
14687
  :type QrCodeId: str
14652
- :param _QrCodeUrl: 二维码url
14688
+ :param _QrCodeUrl: 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
14653
14689
  :type QrCodeUrl: str
14654
- :param _ExpiredTime: 二维码过期时间戳,单位秒
14690
+ :param _ExpiredTime: 二维码的有截止时间,格式为Unix标准时间戳(秒)。
14691
+ 一旦超过二维码的有效期限,该二维码将自动失效。
14655
14692
  :type ExpiredTime: int
14656
14693
  """
14657
14694
  self._QrCodeId = None
@@ -14698,17 +14735,20 @@ class SignQrCode(AbstractModel):
14698
14735
 
14699
14736
 
14700
14737
  class SignUrl(AbstractModel):
14701
- """一码多扫签署二维码签署信息
14738
+ """流程签署二维码的签署信息,适用于客户系统整合二维码功能。
14739
+ 通过链接,用户可直接访问电子签名小程序并签署合同。
14702
14740
 
14703
14741
  """
14704
14742
 
14705
14743
  def __init__(self):
14706
14744
  r"""
14707
- :param _AppSignUrl: 小程序签署链接
14745
+ :param _AppSignUrl: 跳转至电子签名小程序签署的链接地址。
14746
+ 适用于客户端APP及小程序直接唤起电子签名小程序。
14708
14747
  :type AppSignUrl: str
14709
- :param _EffectiveTime: 签署链接有效时间
14748
+ :param _EffectiveTime: 签署链接有效时间,格式类似"2022-08-05 15:55:01"
14710
14749
  :type EffectiveTime: str
14711
- :param _HttpSignUrl: 移动端签署链接
14750
+ :param _HttpSignUrl: 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
14751
+ 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
14712
14752
  :type HttpSignUrl: str
14713
14753
  """
14714
14754
  self._AppSignUrl = None
@@ -15020,19 +15060,20 @@ class StartFlowRequest(AbstractModel):
15020
15060
 
15021
15061
  def __init__(self):
15022
15062
  r"""
15023
- :param _Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
15063
+ :param _Operator: 执行本接口操作的员工信息。
15064
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
15024
15065
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
15025
- :param _FlowId: 签署流程编号,由CreateFlow接口返回
15066
+ :param _FlowId: 合同流程ID,为32位字符串。
15067
+ 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
15026
15068
  :type FlowId: str
15027
15069
  :param _ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
15028
15070
  :type ClientToken: str
15029
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
15071
+ :param _Agent: 代理企业和员工的信息。
15072
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
15030
15073
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
15031
- :param _CcNotifyType: 给关注人发送短信通知的类型,
15032
-
15033
- 0-合同发起时通知
15034
-
15035
- 1-签署完成后通知
15074
+ :param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
15075
+ 0 - 合同发起时通知(默认)
15076
+ 1 - 签署完成后通知
15036
15077
  :type CcNotifyType: int
15037
15078
  """
15038
15079
  self._Operator = None
@@ -15059,10 +15100,14 @@ class StartFlowRequest(AbstractModel):
15059
15100
 
15060
15101
  @property
15061
15102
  def ClientToken(self):
15103
+ warnings.warn("parameter `ClientToken` is deprecated", DeprecationWarning)
15104
+
15062
15105
  return self._ClientToken
15063
15106
 
15064
15107
  @ClientToken.setter
15065
15108
  def ClientToken(self, ClientToken):
15109
+ warnings.warn("parameter `ClientToken` is deprecated", DeprecationWarning)
15110
+
15066
15111
  self._ClientToken = ClientToken
15067
15112
 
15068
15113
  @property
@@ -15109,13 +15154,10 @@ class StartFlowResponse(AbstractModel):
15109
15154
 
15110
15155
  def __init__(self):
15111
15156
  r"""
15112
- :param _Status: 发起成功之后返回状态,
15113
-
15114
- START-发起成功,
15115
-
15116
- REVIEW-提交审核成功,
15117
-
15118
- EXECUTING-已提交发起任务
15157
+ :param _Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
15158
+ START - 发起成功
15159
+ REVIEW - 提交审核成功
15160
+ EXECUTING - 已提交发起任务
15119
15161
  :type Status: str
15120
15162
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
15121
15163
  :type RequestId: str
@@ -991,6 +991,13 @@ class EssbasicClient(AbstractClient):
991
991
  其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
992
992
  使用CreateSignUrls,设置EndPoint为APP,得到path。
993
993
 
994
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
995
+
996
+ | 小程序 | AppID | 原始ID |
997
+ | ------------ | ------------ | ------------ |
998
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
999
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
1000
+
994
1001
  :param request: Request instance for CreateSignUrls.
995
1002
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateSignUrlsRequest`
996
1003
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateSignUrlsResponse`
@@ -7162,24 +7162,31 @@ class CreateSignUrlsRequest(AbstractModel):
7162
7162
  r"""
7163
7163
  :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
7164
7164
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7165
- :param _FlowIds: 签署流程编号数组,最多支持100个。(备注:该参数和合同组编号必须二选一)
7165
+ :param _FlowIds: 流程(合同)的编号列表,最多支持100个。(备注:该参数和合同组编号必须二选一)
7166
7166
  :type FlowIds: list of str
7167
7167
  :param _FlowGroupId: 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
7168
7168
  :type FlowGroupId: str
7169
- :param _Endpoint: 签署链接类型:“WEIXINAPP”-短链直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;"LONGURL2WEIXINAPP"-长链接跳转小程序;默认“WEIXINAPP”类型,即跳转至小程序;
7169
+ :param _Endpoint: 签署链接类型,可以设置的参数如下
7170
+
7171
+ - WEIXINAPP:短链直接跳小程序 (默认类型)
7172
+ - CHANNEL:跳转H5页面
7173
+ - APP:第三方APP或小程序跳转电子签小程序
7174
+ - LONGURL2WEIXINAPP:长链接跳转小程序
7170
7175
  :type Endpoint: str
7171
- :param _GenerateType: 签署链接生成类型,默认是 "ALL";
7172
- "ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
7173
- "CHANNEL":第三方平台子客企业企业;
7174
- "NOT_CHANNEL":非第三方平台子客企业企业;
7175
- "PERSON":个人;
7176
- "FOLLOWER":关注方,目前是合同抄送方;
7176
+ :param _GenerateType: 签署链接生成类型,可以选择的类型如下
7177
+
7178
+ - ALL:全部签署方签署链接,此时不会给自动签署的签署方创建签署链接(默认类型)
7179
+ - CHANNEL:第三方平台子客企业企业
7180
+ - NOT_CHANNEL:非第三方平台子客企业企业
7181
+ - PERSON:个人
7182
+ - FOLLOWER:关注方,目前是合同抄送方
7177
7183
  :type GenerateType: str
7178
7184
  :param _OrganizationName: 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
7179
7185
  :type OrganizationName: str
7180
- :param _Name: 参与人姓名,GenerateType为"PERSON"时必填
7186
+ :param _Name: 参与人姓名
7187
+ GenerateType为"PERSON"(即个人签署方)时必填
7181
7188
  :type Name: str
7182
- :param _Mobile: 参与人手机号;
7189
+ :param _Mobile: 参与人手机号
7183
7190
  GenerateType为"PERSON"或"FOLLOWER"时必填
7184
7191
  :type Mobile: str
7185
7192
  :param _OrganizationOpenId: 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
@@ -7194,10 +7201,10 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
7194
7201
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
7195
7202
  :param _Hides: 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
7196
7203
 
7197
- 0:合同签署页面更多操作按钮
7198
- 1:合同签署页面更多操作的拒绝签署按钮
7199
- 2:合同签署页面更多操作的转他人处理按钮
7200
- 3:签署成功页的查看详情按钮
7204
+ - 0:合同签署页面更多操作按钮
7205
+ - 1:合同签署页面更多操作的拒绝签署按钮
7206
+ - 2:合同签署页面更多操作的转他人处理按钮
7207
+ - 3:签署成功页的查看详情按钮
7201
7208
  :type Hides: list of int
7202
7209
  """
7203
7210
  self._Agent = None
@@ -11932,7 +11939,7 @@ class SignUrlInfo(AbstractModel):
11932
11939
 
11933
11940
  def __init__(self):
11934
11941
  r"""
11935
- :param _SignUrl: 签署链接,过期时间为30
11942
+ :param _SignUrl: 签署链接,过期时间为90
11936
11943
  注意:此字段可能返回 null,表示取不到有效值。
11937
11944
  :type SignUrl: str
11938
11945
  :param _Deadline: 合同过期时间戳,单位秒