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
@@ -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
@@ -1003,13 +1003,16 @@ class CancelFlowRequest(AbstractModel):
1003
1003
 
1004
1004
  def __init__(self):
1005
1005
  r"""
1006
- :param _Operator: 调用方用户信息,userId 必填
1006
+ :param _Operator: 执行本接口操作的员工信息。
1007
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1007
1008
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
1008
- :param _FlowId: 签署流程id
1009
+ :param _FlowId: 合同流程ID, 为32位字符串。
1010
+ 建议开发者保存此流程ID方便后续其他操作。
1009
1011
  :type FlowId: str
1010
- :param _CancelMessage: 撤销原因,最长200个字符;
1012
+ :param _CancelMessage: 撤销此合同(流程)的原因,最长200个字。
1011
1013
  :type CancelMessage: str
1012
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1014
+ :param _Agent: 代理企业和员工的信息。
1015
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1013
1016
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
1014
1017
  """
1015
1018
  self._Operator = None
@@ -1101,11 +1104,13 @@ class CancelMultiFlowSignQRCodeRequest(AbstractModel):
1101
1104
 
1102
1105
  def __init__(self):
1103
1106
  r"""
1104
- :param _Operator: 调用方用户信息,userId 必填
1107
+ :param _Operator: 执行本接口操作的员工信息。
1108
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1105
1109
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
1106
- :param _QrCodeId: 二维码id
1110
+ :param _QrCodeId: 二维码ID,为32位字符串。
1107
1111
  :type QrCodeId: str
1108
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1112
+ :param _Agent: 代理企业和员工的信息。
1113
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1109
1114
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
1110
1115
  """
1111
1116
  self._Operator = None
@@ -1187,17 +1192,25 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
1187
1192
 
1188
1193
  def __init__(self):
1189
1194
  r"""
1190
- :param _Operator: 操作人信息,UseId必填
1195
+ :param _Operator: 执行本接口操作的员工信息。
1196
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1191
1197
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
1192
- :param _SceneKey: 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
1198
+ :param _SceneKey: 企业开通用户自动签场景,例如电子处方。
1199
+ <ul>
1200
+ <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
1201
+ </ul>
1193
1202
  :type SceneKey: str
1194
1203
  :param _UserInfo: 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
1195
1204
 
1196
1205
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
1206
+ :param _Agent: 代理企业和员工的信息。
1207
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1208
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
1197
1209
  """
1198
1210
  self._Operator = None
1199
1211
  self._SceneKey = None
1200
1212
  self._UserInfo = None
1213
+ self._Agent = None
1201
1214
 
1202
1215
  @property
1203
1216
  def Operator(self):
@@ -1223,6 +1236,14 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
1223
1236
  def UserInfo(self, UserInfo):
1224
1237
  self._UserInfo = UserInfo
1225
1238
 
1239
+ @property
1240
+ def Agent(self):
1241
+ return self._Agent
1242
+
1243
+ @Agent.setter
1244
+ def Agent(self, Agent):
1245
+ self._Agent = Agent
1246
+
1226
1247
 
1227
1248
  def _deserialize(self, params):
1228
1249
  if params.get("Operator") is not None:
@@ -1232,6 +1253,9 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
1232
1253
  if params.get("UserInfo") is not None:
1233
1254
  self._UserInfo = UserThreeFactor()
1234
1255
  self._UserInfo._deserialize(params.get("UserInfo"))
1256
+ if params.get("Agent") is not None:
1257
+ self._Agent = Agent()
1258
+ self._Agent._deserialize(params.get("Agent"))
1235
1259
  memeber_set = set(params.keys())
1236
1260
  for name, value in vars(self).items():
1237
1261
  property_name = name[1:]
@@ -4196,19 +4220,25 @@ class CreateFlowSignUrlRequest(AbstractModel):
4196
4220
 
4197
4221
  def __init__(self):
4198
4222
  r"""
4199
- :param _FlowId: 流程编号
4223
+ :param _FlowId: 合同流程ID,为32位字符串。
4224
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
4225
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4200
4226
  :type FlowId: str
4201
- :param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
4227
+ :param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
4202
4228
 
4203
- 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
4229
+ 注:
4230
+ `1. ApproverType目前只支持个人类型的签署人。`
4231
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4204
4232
  :type FlowApproverInfos: list of FlowCreateApprover
4205
- :param _Operator: 用户信息,此结构体UserId必填
4233
+ :param _Operator: 执行本接口操作的员工信息。
4234
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4206
4235
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
4207
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4236
+ :param _Agent: 代理企业和员工的信息。
4237
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4208
4238
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
4209
4239
  :param _Organization: 机构信息,暂未开放
4210
4240
  :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
4211
- :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
4241
+ :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
4212
4242
  :type JumpUrl: str
4213
4243
  """
4214
4244
  self._FlowId = None
@@ -4874,33 +4904,39 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4874
4904
 
4875
4905
  def __init__(self):
4876
4906
  r"""
4877
- :param _Operator: 用户信息,其中UserId为必填参数
4907
+ :param _Operator: 执行本接口操作的员工信息。
4908
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4878
4909
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
4879
- :param _TemplateId: 模板ID
4910
+ :param _TemplateId: 合同模板ID,为32位字符串。
4911
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
4880
4912
  :type TemplateId: str
4881
- :param _FlowName: 签署流程名称,最大长度不超过200字符
4913
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
4914
+ 该名称还将用于合同签署完成后的下载文件名。
4882
4915
  :type FlowName: str
4883
- :param _MaxFlowNum: 最大可发起签署流程份数,默认5
4884
- <br/>发起流程数量超过此上限后二维码自动失效
4916
+ :param _MaxFlowNum: 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
4917
+ 一旦发起流程数超越该限制,该二维码将自动失效。
4885
4918
  :type MaxFlowNum: int
4886
- :param _FlowEffectiveDay: 签署流程有效天数
4887
- <br/>默认7天
4888
- <br/>最高设置不超过30天
4889
- :type FlowEffectiveDay: int
4890
- :param _QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
4919
+ :param _QrEffectiveDay: 二维码的有效期限,默认为7天,最高设定不得超过90天。
4920
+ 一旦超过二维码的有效期限,该二维码将自动失效。
4891
4921
  :type QrEffectiveDay: int
4892
- :param _Restrictions: 指定的签署人信息
4893
- <br/>指定后,则只允许指定的签署人扫码签署
4922
+ :param _FlowEffectiveDay: 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
4923
+ 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
4924
+ 最长设定期限不得超过30天。
4925
+ :type FlowEffectiveDay: int
4926
+ :param _Restrictions: 指定签署人信息。
4927
+ 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
4894
4928
  :type Restrictions: list of ApproverRestriction
4895
- :param _UserData: 用户自定义字段
4896
- <br/>回调的时候会进行透传,长度需要小于20480
4929
+ :param _UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
4930
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
4931
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
4897
4932
  :type UserData: str
4898
4933
  :param _CallbackUrl: 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
4899
4934
  <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
4900
4935
  <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
4936
 
4902
4937
  :type CallbackUrl: str
4903
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4938
+ :param _Agent: 代理企业和员工的信息。
4939
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4904
4940
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
4905
4941
  :param _ApproverRestrictions: 限制二维码用户条件(已弃用)
4906
4942
  :type ApproverRestrictions: :class:`tencentcloud.ess.v20201111.models.ApproverRestriction`
@@ -4909,8 +4945,8 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4909
4945
  self._TemplateId = None
4910
4946
  self._FlowName = None
4911
4947
  self._MaxFlowNum = None
4912
- self._FlowEffectiveDay = None
4913
4948
  self._QrEffectiveDay = None
4949
+ self._FlowEffectiveDay = None
4914
4950
  self._Restrictions = None
4915
4951
  self._UserData = None
4916
4952
  self._CallbackUrl = None
@@ -4949,14 +4985,6 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4949
4985
  def MaxFlowNum(self, MaxFlowNum):
4950
4986
  self._MaxFlowNum = MaxFlowNum
4951
4987
 
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
4988
  @property
4961
4989
  def QrEffectiveDay(self):
4962
4990
  return self._QrEffectiveDay
@@ -4965,6 +4993,14 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
4965
4993
  def QrEffectiveDay(self, QrEffectiveDay):
4966
4994
  self._QrEffectiveDay = QrEffectiveDay
4967
4995
 
4996
+ @property
4997
+ def FlowEffectiveDay(self):
4998
+ return self._FlowEffectiveDay
4999
+
5000
+ @FlowEffectiveDay.setter
5001
+ def FlowEffectiveDay(self, FlowEffectiveDay):
5002
+ self._FlowEffectiveDay = FlowEffectiveDay
5003
+
4968
5004
  @property
4969
5005
  def Restrictions(self):
4970
5006
  return self._Restrictions
@@ -5021,8 +5057,8 @@ class CreateMultiFlowSignQRCodeRequest(AbstractModel):
5021
5057
  self._TemplateId = params.get("TemplateId")
5022
5058
  self._FlowName = params.get("FlowName")
5023
5059
  self._MaxFlowNum = params.get("MaxFlowNum")
5024
- self._FlowEffectiveDay = params.get("FlowEffectiveDay")
5025
5060
  self._QrEffectiveDay = params.get("QrEffectiveDay")
5061
+ self._FlowEffectiveDay = params.get("FlowEffectiveDay")
5026
5062
  if params.get("Restrictions") is not None:
5027
5063
  self._Restrictions = []
5028
5064
  for item in params.get("Restrictions"):
@@ -5054,9 +5090,9 @@ class CreateMultiFlowSignQRCodeResponse(AbstractModel):
5054
5090
 
5055
5091
  def __init__(self):
5056
5092
  r"""
5057
- :param _QrCode: 签署二维码对象
5093
+ :param _QrCode: 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
5058
5094
  :type QrCode: :class:`tencentcloud.ess.v20201111.models.SignQrCode`
5059
- :param _SignUrls: 签署链接对象
5095
+ :param _SignUrls: 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
5060
5096
  :type SignUrls: :class:`tencentcloud.ess.v20201111.models.SignUrl`
5061
5097
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5062
5098
  :type RequestId: str
@@ -5981,27 +6017,37 @@ class CreateReleaseFlowRequest(AbstractModel):
5981
6017
 
5982
6018
  def __init__(self):
5983
6019
  r"""
5984
- :param _Operator: 调用方用户信息,userId 必填
6020
+ :param _Operator: 执行本接口操作的员工信息。
6021
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5985
6022
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
5986
- :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)
6023
+ :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
5987
6024
  :type NeedRelievedFlowId: str
5988
- :param _ReliveInfo: 解除协议内容
6025
+ :param _ReliveInfo: 解除协议内容。
5989
6026
  :type ReliveInfo: :class:`tencentcloud.ess.v20201111.models.RelieveInfo`
5990
- :param _ReleasedApprovers: 非必须,解除协议的本企业签署人列表,
5991
- 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
5992
- 解除协议的签署人数量不能多于原流程的签署人数量
6027
+ :param _Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6028
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6029
+ :param _ReleasedApprovers: 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
6030
+ 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
6031
+ 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
6032
+
6033
+ `注意:只能更换同企业的签署人。`<br/>
6034
+ `注意:不支持更换个人类型的签署人。`<br/>
5993
6035
  :type ReleasedApprovers: list of ReleasedApprover
5994
- :param _Deadline: 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
6036
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
6037
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
5995
6038
  :type Deadline: int
5996
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5997
- :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6039
+ :param _UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
6040
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
6041
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
6042
+ :type UserData: str
5998
6043
  """
5999
6044
  self._Operator = None
6000
6045
  self._NeedRelievedFlowId = None
6001
6046
  self._ReliveInfo = None
6047
+ self._Agent = None
6002
6048
  self._ReleasedApprovers = None
6003
6049
  self._Deadline = None
6004
- self._Agent = None
6050
+ self._UserData = None
6005
6051
 
6006
6052
  @property
6007
6053
  def Operator(self):
@@ -6027,6 +6073,14 @@ class CreateReleaseFlowRequest(AbstractModel):
6027
6073
  def ReliveInfo(self, ReliveInfo):
6028
6074
  self._ReliveInfo = ReliveInfo
6029
6075
 
6076
+ @property
6077
+ def Agent(self):
6078
+ return self._Agent
6079
+
6080
+ @Agent.setter
6081
+ def Agent(self, Agent):
6082
+ self._Agent = Agent
6083
+
6030
6084
  @property
6031
6085
  def ReleasedApprovers(self):
6032
6086
  return self._ReleasedApprovers
@@ -6044,12 +6098,12 @@ class CreateReleaseFlowRequest(AbstractModel):
6044
6098
  self._Deadline = Deadline
6045
6099
 
6046
6100
  @property
6047
- def Agent(self):
6048
- return self._Agent
6101
+ def UserData(self):
6102
+ return self._UserData
6049
6103
 
6050
- @Agent.setter
6051
- def Agent(self, Agent):
6052
- self._Agent = Agent
6104
+ @UserData.setter
6105
+ def UserData(self, UserData):
6106
+ self._UserData = UserData
6053
6107
 
6054
6108
 
6055
6109
  def _deserialize(self, params):
@@ -6060,6 +6114,9 @@ class CreateReleaseFlowRequest(AbstractModel):
6060
6114
  if params.get("ReliveInfo") is not None:
6061
6115
  self._ReliveInfo = RelieveInfo()
6062
6116
  self._ReliveInfo._deserialize(params.get("ReliveInfo"))
6117
+ if params.get("Agent") is not None:
6118
+ self._Agent = Agent()
6119
+ self._Agent._deserialize(params.get("Agent"))
6063
6120
  if params.get("ReleasedApprovers") is not None:
6064
6121
  self._ReleasedApprovers = []
6065
6122
  for item in params.get("ReleasedApprovers"):
@@ -6067,9 +6124,7 @@ class CreateReleaseFlowRequest(AbstractModel):
6067
6124
  obj._deserialize(item)
6068
6125
  self._ReleasedApprovers.append(obj)
6069
6126
  self._Deadline = params.get("Deadline")
6070
- if params.get("Agent") is not None:
6071
- self._Agent = Agent()
6072
- self._Agent._deserialize(params.get("Agent"))
6127
+ self._UserData = params.get("UserData")
6073
6128
  memeber_set = set(params.keys())
6074
6129
  for name, value in vars(self).items():
6075
6130
  property_name = name[1:]
@@ -6088,6 +6143,7 @@ class CreateReleaseFlowResponse(AbstractModel):
6088
6143
  def __init__(self):
6089
6144
  r"""
6090
6145
  :param _FlowId: 解除协议流程编号
6146
+ `注意:这里的流程编号对应的合同是本次发起的解除协议。`
6091
6147
 
6092
6148
  :type FlowId: str
6093
6149
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -6125,45 +6181,49 @@ class CreateSchemeUrlRequest(AbstractModel):
6125
6181
 
6126
6182
  def __init__(self):
6127
6183
  r"""
6128
- :param _Operator: 调用方用户信息,userId 必填
6184
+ :param _Operator: 执行本接口操作的员工信息, userId 必填。
6185
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6129
6186
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
6130
- :param _OrganizationName: 企业名称
6187
+ :param _OrganizationName: 合同流程签署方的组织机构名称。
6188
+ 如果名称中包含英文括号(),请使用中文括号()代替。
6131
6189
  :type OrganizationName: str
6132
- :param _Name: 姓名,最大长度50个字符
6190
+ :param _Name: 合同流程里边签署方经办人的姓名。
6191
+
6133
6192
  :type Name: str
6134
- :param _Mobile: 手机号,大陆手机号11
6193
+ :param _Mobile: 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
6135
6194
  :type Mobile: str
6136
6195
  :param _EndPoint: 要跳转的链接类型
6137
6196
 
6138
- - HTTP:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 (默认),此时返回长链
6139
- - HTTP_SHORT_URL:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
6140
- - APP 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
6141
-
6197
+ <ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li>
6198
+ <li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li>
6199
+ <li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
6142
6200
  :type EndPoint: str
6143
- :param _FlowId: 签署流程编号 (PathType=1时必传)
6201
+ :param _FlowId: 合同流程ID
6202
+ 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
6144
6203
  :type FlowId: str
6145
- :param _FlowGroupId: 合同组ID
6204
+ :param _FlowGroupId: 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
6146
6205
  :type FlowGroupId: str
6147
6206
  :param _PathType: 要跳转到的页面类型
6148
6207
 
6149
- - 0: 不传, 主页 (默认)
6150
- - 1: 小程序合同详情
6151
- - 2: 小程序合同列表页
6152
-
6208
+ <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
6209
+ <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
6210
+ <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
6153
6211
  :type PathType: int
6154
- :param _AutoJumpBack: 是否自动回跳
6155
- true:是,
6156
- false:否。
6157
- 该参数只针对"APP" 类型的签署链接有效
6212
+ :param _AutoJumpBack: 签署完成后是否自动回跳
6213
+ <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
6214
+ 注: ` 该参数只针对"APP" 类型的签署链接有效`
6158
6215
  :type AutoJumpBack: bool
6159
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
6216
+ :param _Agent: 代理企业和员工的信息。
6217
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6160
6218
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6161
- :param _Hides: 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
6219
+ :param _Hides: 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
6220
+
6221
+ <ul><li> **0** :合同签署页面更多操作按钮</li>
6222
+ <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
6223
+ <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
6224
+ <li> **3** :签署成功页的查看详情按钮</li></ul>
6162
6225
 
6163
- - 0:合同签署页面更多操作按钮
6164
- - 1:合同签署页面更多操作的拒绝签署按钮
6165
- - 2:合同签署页面更多操作的转他人处理按钮
6166
- - 3:签署成功页的查看详情按钮
6226
+ 注: `字段为数组, 可以传值隐藏多个按钮`
6167
6227
  :type Hides: list of int
6168
6228
  """
6169
6229
  self._Operator = None
@@ -6300,7 +6360,11 @@ class CreateSchemeUrlResponse(AbstractModel):
6300
6360
 
6301
6361
  def __init__(self):
6302
6362
  r"""
6303
- :param _SchemeUrl: 小程序链接地址,有效期90天。如果EndPoint是App,得到的链接Path如’weixin://dl/business/?t= *TICKET*‘,用于客户APP、小程序直接拉起电子签小程序;其他EndPoint得到的https链接如'https://essurl.cn/xxx',点击链接会打开一个H5页面,然后拉起电子签小程序。
6363
+ :param _SchemeUrl: 腾讯电子签小程序的签署链接。
6364
+
6365
+ <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
6366
+ <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>
6367
+ <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
6304
6368
  :type SchemeUrl: str
6305
6369
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6306
6370
  :type RequestId: str
@@ -7680,21 +7744,25 @@ class DescribeExtendedServiceAuthInfosRequest(AbstractModel):
7680
7744
 
7681
7745
  def __init__(self):
7682
7746
  r"""
7683
- :param _Operator: 操作人信息
7747
+ :param _Operator: 执行本接口操作的员工信息。
7748
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
7684
7749
  :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:批量签署
7750
+ :param _ExtendServiceType: 要查询的扩展服务类型。
7751
+ 默认为空,即查询当前支持的所有扩展服务信息。
7752
+ 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
7753
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
7754
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
7755
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
7756
+ <li>PAGING_SEAL:骑缝章</li>
7757
+ <li>BATCH_SIGN:批量签署</li></ul>
7693
7758
  :type ExtendServiceType: str
7759
+ :param _Agent: 代理企业和员工的信息。
7760
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
7761
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
7694
7762
  """
7695
7763
  self._Operator = None
7696
- self._Agent = None
7697
7764
  self._ExtendServiceType = None
7765
+ self._Agent = None
7698
7766
 
7699
7767
  @property
7700
7768
  def Operator(self):
@@ -7704,14 +7772,6 @@ BATCH_SIGN:批量签署
7704
7772
  def Operator(self, Operator):
7705
7773
  self._Operator = Operator
7706
7774
 
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
7775
  @property
7716
7776
  def ExtendServiceType(self):
7717
7777
  return self._ExtendServiceType
@@ -7720,15 +7780,23 @@ BATCH_SIGN:批量签署
7720
7780
  def ExtendServiceType(self, ExtendServiceType):
7721
7781
  self._ExtendServiceType = ExtendServiceType
7722
7782
 
7783
+ @property
7784
+ def Agent(self):
7785
+ return self._Agent
7786
+
7787
+ @Agent.setter
7788
+ def Agent(self, Agent):
7789
+ self._Agent = Agent
7790
+
7723
7791
 
7724
7792
  def _deserialize(self, params):
7725
7793
  if params.get("Operator") is not None:
7726
7794
  self._Operator = UserInfo()
7727
7795
  self._Operator._deserialize(params.get("Operator"))
7796
+ self._ExtendServiceType = params.get("ExtendServiceType")
7728
7797
  if params.get("Agent") is not None:
7729
7798
  self._Agent = Agent()
7730
7799
  self._Agent._deserialize(params.get("Agent"))
7731
- self._ExtendServiceType = params.get("ExtendServiceType")
7732
7800
  memeber_set = set(params.keys())
7733
7801
  for name, value in vars(self).items():
7734
7802
  property_name = name[1:]
@@ -7746,7 +7814,7 @@ class DescribeExtendedServiceAuthInfosResponse(AbstractModel):
7746
7814
 
7747
7815
  def __init__(self):
7748
7816
  r"""
7749
- :param _AuthInfoList: 授权服务信息列表
7817
+ :param _AuthInfoList: 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
7750
7818
  :type AuthInfoList: list of ExtendAuthInfo
7751
7819
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7752
7820
  :type RequestId: str
@@ -8221,12 +8289,13 @@ class DescribeFlowEvidenceReportRequest(AbstractModel):
8221
8289
 
8222
8290
  def __init__(self):
8223
8291
  r"""
8224
- :param _Operator: 调用方用户信息,userId 必填
8292
+ :param _Operator: 执行本接口操作的员工信息。
8293
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
8225
8294
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
8226
- :param _ReportId: 出证报告编号
8295
+ :param _ReportId: 签署报告编号
8227
8296
  :type ReportId: str
8228
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
8229
-
8297
+ :param _Agent: 代理企业和员工的信息。
8298
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8230
8299
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
8231
8300
  """
8232
8301
  self._Operator = None
@@ -8286,11 +8355,12 @@ class DescribeFlowEvidenceReportResponse(AbstractModel):
8286
8355
  :param _ReportUrl: 出证报告PDF的下载 URL
8287
8356
  注意:此字段可能返回 null,表示取不到有效值。
8288
8357
  :type ReportUrl: str
8289
- :param _Status: 出证任务执行的状态, 分布表示下面的含义
8290
-
8291
- EvidenceStatusExecuting 出证任务在执行中
8292
- EvidenceStatusSuccess 出证任务执行成功
8293
- EvidenceStatusFailed 出证任务执行失败
8358
+ :param _Status: 签署报告出证任务的状态
8359
+ <ul>
8360
+ <li>EvidenceStatusExecuting : 出证任务在执行中</li>
8361
+ <li>EvidenceStatusSuccess : 出证任务执行成功</li>
8362
+ <li>EvidenceStatusFailed : 出证任务执行失败</li>
8363
+ </ul>
8294
8364
  :type Status: str
8295
8365
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8296
8366
  :type RequestId: str
@@ -10063,31 +10133,32 @@ class EmbedUrlOption(AbstractModel):
10063
10133
 
10064
10134
 
10065
10135
  class ExtendAuthInfo(AbstractModel):
10066
- """授权服务信息
10136
+ """扩展服务开通和授权的详细信息
10067
10137
 
10068
10138
  """
10069
10139
 
10070
10140
  def __init__(self):
10071
10141
  r"""
10072
- :param _Type: 授权服务类型
10073
- OPEN_SERVER_SIGN:开通企业静默签署
10074
- OVERSEA_SIGN:企业与港澳台居民签署合同
10075
- MOBILE_CHECK_APPROVER:使用手机号验证签署方身份
10076
- PAGING_SEAL:骑缝章
10077
- BATCH_SIGN:批量签署
10142
+ :param _Type: 扩展服务的类型,可能是以下值:
10143
+ <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
10144
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
10145
+ <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
10146
+ <li>PAGING_SEAL:骑缝章</li>
10147
+ <li>BATCH_SIGN:批量签署</li></ul>
10078
10148
  :type Type: str
10079
- :param _Name: 授权服务名称
10149
+ :param _Name: 扩展服务的名称
10080
10150
  :type Name: str
10081
- :param _Status: 授权服务状态,ENABLE:开通
10151
+ :param _Status: 扩展服务的开通状态:
10152
+ ENABLE:开通
10082
10153
  DISABLE:未开通
10083
10154
  :type Status: str
10084
- :param _OperatorUserId: 授权人用户id
10155
+ :param _OperatorUserId: 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
10085
10156
  注意:此字段可能返回 null,表示取不到有效值。
10086
10157
  :type OperatorUserId: str
10087
- :param _OperateOn: 授权时间戳,单位秒
10158
+ :param _OperateOn: 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
10088
10159
  注意:此字段可能返回 null,表示取不到有效值。
10089
10160
  :type OperateOn: int
10090
- :param _HasAuthUserList: 被授权用户列表
10161
+ :param _HasAuthUserList: 该扩展服务若可以授权,此参数对应授权人员的列表
10091
10162
  注意:此字段可能返回 null,表示取不到有效值。
10092
10163
  :type HasAuthUserList: list of HasAuthUser
10093
10164
  """
@@ -10824,6 +10895,9 @@ class FlowApproverDetail(AbstractModel):
10824
10895
  :param _OrganizationName: 签署方企业名称
10825
10896
  注意:此字段可能返回 null,表示取不到有效值。
10826
10897
  :type OrganizationName: str
10898
+ :param _SignId: 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
10899
+ 注意:此字段可能返回 null,表示取不到有效值。
10900
+ :type SignId: str
10827
10901
  """
10828
10902
  self._ApproveMessage = None
10829
10903
  self._ApproveName = None
@@ -10838,6 +10912,7 @@ class FlowApproverDetail(AbstractModel):
10838
10912
  self._CustomApproverTag = None
10839
10913
  self._OrganizationId = None
10840
10914
  self._OrganizationName = None
10915
+ self._SignId = None
10841
10916
 
10842
10917
  @property
10843
10918
  def ApproveMessage(self):
@@ -10943,6 +11018,14 @@ class FlowApproverDetail(AbstractModel):
10943
11018
  def OrganizationName(self, OrganizationName):
10944
11019
  self._OrganizationName = OrganizationName
10945
11020
 
11021
+ @property
11022
+ def SignId(self):
11023
+ return self._SignId
11024
+
11025
+ @SignId.setter
11026
+ def SignId(self, SignId):
11027
+ self._SignId = SignId
11028
+
10946
11029
 
10947
11030
  def _deserialize(self, params):
10948
11031
  self._ApproveMessage = params.get("ApproveMessage")
@@ -10958,6 +11041,7 @@ class FlowApproverDetail(AbstractModel):
10958
11041
  self._CustomApproverTag = params.get("CustomApproverTag")
10959
11042
  self._OrganizationId = params.get("OrganizationId")
10960
11043
  self._OrganizationName = params.get("OrganizationName")
11044
+ self._SignId = params.get("SignId")
10961
11045
  memeber_set = set(params.keys())
10962
11046
  for name, value in vars(self).items():
10963
11047
  property_name = name[1:]
@@ -10975,10 +11059,14 @@ class FlowApproverUrlInfo(AbstractModel):
10975
11059
 
10976
11060
  def __init__(self):
10977
11061
  r"""
10978
- :param _SignUrl: 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
11062
+ :param _SignUrl: 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
11063
+ 注: `注意该链接有效期为30分钟`
10979
11064
  注意:此字段可能返回 null,表示取不到有效值。
10980
11065
  :type SignUrl: str
10981
- :param _ApproverType: 签署人类型 1-个人
11066
+ :param _ApproverType: 签署参与人类型
11067
+ <ul><li> **1** :个人参与方</li></ul>
11068
+
11069
+ 注: `现在仅支持个人参与方`
10982
11070
  注意:此字段可能返回 null,表示取不到有效值。
10983
11071
  :type ApproverType: int
10984
11072
  :param _ApproverName: 签署人姓名
@@ -10987,7 +11075,8 @@ class FlowApproverUrlInfo(AbstractModel):
10987
11075
  :param _ApproverMobile: 签署人手机号
10988
11076
  注意:此字段可能返回 null,表示取不到有效值。
10989
11077
  :type ApproverMobile: str
10990
- :param _LongUrl: 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
11078
+ :param _LongUrl: 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
11079
+ 注: `注意该链接有效期为30分钟`
10991
11080
  注意:此字段可能返回 null,表示取不到有效值。
10992
11081
  :type LongUrl: str
10993
11082
  """
@@ -12585,18 +12674,18 @@ class GroupOrganization(AbstractModel):
12585
12674
 
12586
12675
 
12587
12676
  class HasAuthUser(AbstractModel):
12588
- """被授权用户信息
12677
+ """被授权的用户信息
12589
12678
 
12590
12679
  """
12591
12680
 
12592
12681
  def __init__(self):
12593
12682
  r"""
12594
- :param _UserId: 用户id
12683
+ :param _UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
12595
12684
  注意:此字段可能返回 null,表示取不到有效值。
12596
12685
  :type UserId: str
12597
- :param _BelongTo: 用户归属
12598
- MainOrg:主企业
12599
- CurrentOrg:当前企业
12686
+ :param _BelongTo: 当前员工的归属情况,可能值是:
12687
+ MainOrg:在集团企业的场景下,返回此值代表是归属主企业
12688
+ CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
12600
12689
  注意:此字段可能返回 null,表示取不到有效值。
12601
12690
  :type BelongTo: str
12602
12691
  """
@@ -12890,13 +12979,17 @@ class ModifyApplicationCallbackInfoRequest(AbstractModel):
12890
12979
 
12891
12980
  def __init__(self):
12892
12981
  r"""
12893
- :param _Operator: 调用方用户信息,userId 必填
12982
+ :param _Operator: 执行本接口操作的员工信息。
12983
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
12894
12984
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
12895
- :param _OperateType: 操作类型:1-新增,2-删除
12985
+ :param _OperateType: 操作类型:
12986
+ 1-新增
12987
+ 2-删除
12896
12988
  :type OperateType: int
12897
- :param _CallbackInfo: 回调信息
12989
+ :param _CallbackInfo: 企业应用回调信息
12898
12990
  :type CallbackInfo: :class:`tencentcloud.ess.v20201111.models.CallbackInfo`
12899
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
12991
+ :param _Agent: 代理企业和员工的信息。
12992
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
12900
12993
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
12901
12994
  """
12902
12995
  self._Operator = None
@@ -14641,17 +14734,18 @@ CONTRACT:合同专用章
14641
14734
 
14642
14735
 
14643
14736
  class SignQrCode(AbstractModel):
14644
- """一码多扫签署二维码对象
14737
+ """签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
14645
14738
 
14646
14739
  """
14647
14740
 
14648
14741
  def __init__(self):
14649
14742
  r"""
14650
- :param _QrCodeId: 二维码id
14743
+ :param _QrCodeId: 二维码ID,为32位字符串。
14651
14744
  :type QrCodeId: str
14652
- :param _QrCodeUrl: 二维码url
14745
+ :param _QrCodeUrl: 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
14653
14746
  :type QrCodeUrl: str
14654
- :param _ExpiredTime: 二维码过期时间戳,单位秒
14747
+ :param _ExpiredTime: 二维码的有截止时间,格式为Unix标准时间戳(秒)。
14748
+ 一旦超过二维码的有效期限,该二维码将自动失效。
14655
14749
  :type ExpiredTime: int
14656
14750
  """
14657
14751
  self._QrCodeId = None
@@ -14698,17 +14792,20 @@ class SignQrCode(AbstractModel):
14698
14792
 
14699
14793
 
14700
14794
  class SignUrl(AbstractModel):
14701
- """一码多扫签署二维码签署信息
14795
+ """流程签署二维码的签署信息,适用于客户系统整合二维码功能。
14796
+ 通过链接,用户可直接访问电子签名小程序并签署合同。
14702
14797
 
14703
14798
  """
14704
14799
 
14705
14800
  def __init__(self):
14706
14801
  r"""
14707
- :param _AppSignUrl: 小程序签署链接
14802
+ :param _AppSignUrl: 跳转至电子签名小程序签署的链接地址。
14803
+ 适用于客户端APP及小程序直接唤起电子签名小程序。
14708
14804
  :type AppSignUrl: str
14709
- :param _EffectiveTime: 签署链接有效时间
14805
+ :param _EffectiveTime: 签署链接有效时间,格式类似"2022-08-05 15:55:01"
14710
14806
  :type EffectiveTime: str
14711
- :param _HttpSignUrl: 移动端签署链接
14807
+ :param _HttpSignUrl: 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
14808
+ 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
14712
14809
  :type HttpSignUrl: str
14713
14810
  """
14714
14811
  self._AppSignUrl = None
@@ -15020,19 +15117,20 @@ class StartFlowRequest(AbstractModel):
15020
15117
 
15021
15118
  def __init__(self):
15022
15119
  r"""
15023
- :param _Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
15120
+ :param _Operator: 执行本接口操作的员工信息。
15121
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
15024
15122
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
15025
- :param _FlowId: 签署流程编号,由CreateFlow接口返回
15123
+ :param _FlowId: 合同流程ID,为32位字符串。
15124
+ 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
15026
15125
  :type FlowId: str
15027
15126
  :param _ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
15028
15127
  :type ClientToken: str
15029
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
15128
+ :param _Agent: 代理企业和员工的信息。
15129
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
15030
15130
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
15031
- :param _CcNotifyType: 给关注人发送短信通知的类型,
15032
-
15033
- 0-合同发起时通知
15034
-
15035
- 1-签署完成后通知
15131
+ :param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
15132
+ 0 - 合同发起时通知(默认)
15133
+ 1 - 签署完成后通知
15036
15134
  :type CcNotifyType: int
15037
15135
  """
15038
15136
  self._Operator = None
@@ -15059,10 +15157,14 @@ class StartFlowRequest(AbstractModel):
15059
15157
 
15060
15158
  @property
15061
15159
  def ClientToken(self):
15160
+ warnings.warn("parameter `ClientToken` is deprecated", DeprecationWarning)
15161
+
15062
15162
  return self._ClientToken
15063
15163
 
15064
15164
  @ClientToken.setter
15065
15165
  def ClientToken(self, ClientToken):
15166
+ warnings.warn("parameter `ClientToken` is deprecated", DeprecationWarning)
15167
+
15066
15168
  self._ClientToken = ClientToken
15067
15169
 
15068
15170
  @property
@@ -15109,13 +15211,10 @@ class StartFlowResponse(AbstractModel):
15109
15211
 
15110
15212
  def __init__(self):
15111
15213
  r"""
15112
- :param _Status: 发起成功之后返回状态,
15113
-
15114
- START-发起成功,
15115
-
15116
- REVIEW-提交审核成功,
15117
-
15118
- EXECUTING-已提交发起任务
15214
+ :param _Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
15215
+ START - 发起成功
15216
+ REVIEW - 提交审核成功
15217
+ EXECUTING - 已提交发起任务
15119
15218
  :type Status: str
15120
15219
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
15121
15220
  :type RequestId: str
@@ -16244,14 +16343,18 @@ class UserThreeFactor(AbstractModel):
16244
16343
 
16245
16344
  def __init__(self):
16246
16345
  r"""
16247
- :param _Name: 姓名
16346
+ :param _Name: 签署方经办人的姓名。
16347
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
16248
16348
  :type Name: str
16249
- :param _IdCardType: 证件类型:
16250
- ID_CARD 身份证
16251
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
16252
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
16349
+ :param _IdCardType: 证件类型,支持以下类型
16350
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
16351
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
16352
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
16253
16353
  :type IdCardType: str
16254
- :param _IdCardNumber: 证件号,如果有 X 请大写
16354
+ :param _IdCardNumber: 证件号码,应符合以下规则
16355
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
16356
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
16357
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
16255
16358
  :type IdCardNumber: str
16256
16359
  """
16257
16360
  self._Name = None