tencentcloud-sdk-python-essbasic 3.1.175__py2.py3-none-any.whl → 3.1.188__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.
@@ -422,7 +422,7 @@ class ApproverOption(AbstractModel):
422
422
  :type NoTransfer: bool
423
423
  :param _HideOneKeySign: <p>当签署方有多个签署区时候,是否隐藏一键所有的签署区</p><p>false:(默认)不隐藏<br>true:隐藏,每个签署区要单独选择印章或者签名</p>
424
424
  :type HideOneKeySign: bool
425
- :param _FillType: <p>签署人信息补充类型,默认无需补充。<ul><li> <strong>1</strong> : 动态签署人(可发起合同后再补充签署人信息)注:<code>企业自动签不支持动态补充</code></li></ul>注:<code>使用动态签署人能力前,需登录腾讯电子签控制台打开服务开关</code></p><p>枚举值:</p><ul><li>1: 动态签署人</li></ul>
425
+ :param _FillType: <p>签署人信息补充类型,默认无需补充。<ul><li> <strong>1</strong> : 动态签署人(可发起合同后再补充签署人信息)注:<code>企业“授权签”不支持动态补充</code></li></ul>注:<code>使用动态签署人能力前,需登录腾讯电子签控制台打开服务开关</code></p><p>枚举值:</p><ul><li>1: 动态签署人</li></ul>
426
426
  :type FillType: int
427
427
  :param _FlowReadLimit: <p>签署人阅读合同限制参数<br> <br>取值:</p><ul><li> LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底</li><li> LimitReadTime,阅读合同仅限制阅读时长</li><li> LimitBottom,阅读合同仅限制必须阅读到底</li><li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li></ul>
428
428
  :type FlowReadLimit: str
@@ -477,7 +477,7 @@ class ApproverOption(AbstractModel):
477
477
 
478
478
  @property
479
479
  def FillType(self):
480
- r"""<p>签署人信息补充类型,默认无需补充。<ul><li> <strong>1</strong> : 动态签署人(可发起合同后再补充签署人信息)注:<code>企业自动签不支持动态补充</code></li></ul>注:<code>使用动态签署人能力前,需登录腾讯电子签控制台打开服务开关</code></p><p>枚举值:</p><ul><li>1: 动态签署人</li></ul>
480
+ r"""<p>签署人信息补充类型,默认无需补充。<ul><li> <strong>1</strong> : 动态签署人(可发起合同后再补充签署人信息)注:<code>企业“授权签”不支持动态补充</code></li></ul>注:<code>使用动态签署人能力前,需登录腾讯电子签控制台打开服务开关</code></p><p>枚举值:</p><ul><li>1: 动态签署人</li></ul>
481
481
  :rtype: int
482
482
  """
483
483
  return self._FillType
@@ -825,17 +825,17 @@ class AuthInfoDetail(AbstractModel):
825
825
 
826
826
  def __init__(self):
827
827
  r"""
828
- :param _Type: 扩展服务类型,和入参一致
828
+ :param _Type: <p>扩展服务类型,和入参一致</p>
829
829
  :type Type: str
830
- :param _Name: 扩展服务名称
830
+ :param _Name: <p>扩展服务名称</p>
831
831
  :type Name: str
832
- :param _HasAuthUserList: 授权员工列表
832
+ :param _HasAuthUserList: <p>授权员工列表</p>
833
833
  :type HasAuthUserList: list of HasAuthUser
834
- :param _HasAuthOrganizationList: 授权企业列表(企业自动签时,该字段有值)
834
+ :param _HasAuthOrganizationList: <p>授权企业列表(企业“授权签”时,该字段有值)</p>
835
835
  :type HasAuthOrganizationList: list of HasAuthOrganization
836
- :param _AuthUserTotal: 授权员工列表总数
836
+ :param _AuthUserTotal: <p>授权员工列表总数</p>
837
837
  :type AuthUserTotal: int
838
- :param _AuthOrganizationTotal: 授权企业列表总数
838
+ :param _AuthOrganizationTotal: <p>授权企业列表总数</p>
839
839
  :type AuthOrganizationTotal: int
840
840
  """
841
841
  self._Type = None
@@ -847,7 +847,7 @@ class AuthInfoDetail(AbstractModel):
847
847
 
848
848
  @property
849
849
  def Type(self):
850
- r"""扩展服务类型,和入参一致
850
+ r"""<p>扩展服务类型,和入参一致</p>
851
851
  :rtype: str
852
852
  """
853
853
  return self._Type
@@ -858,7 +858,7 @@ class AuthInfoDetail(AbstractModel):
858
858
 
859
859
  @property
860
860
  def Name(self):
861
- r"""扩展服务名称
861
+ r"""<p>扩展服务名称</p>
862
862
  :rtype: str
863
863
  """
864
864
  return self._Name
@@ -869,7 +869,7 @@ class AuthInfoDetail(AbstractModel):
869
869
 
870
870
  @property
871
871
  def HasAuthUserList(self):
872
- r"""授权员工列表
872
+ r"""<p>授权员工列表</p>
873
873
  :rtype: list of HasAuthUser
874
874
  """
875
875
  return self._HasAuthUserList
@@ -880,7 +880,7 @@ class AuthInfoDetail(AbstractModel):
880
880
 
881
881
  @property
882
882
  def HasAuthOrganizationList(self):
883
- r"""授权企业列表(企业自动签时,该字段有值)
883
+ r"""<p>授权企业列表(企业“授权签”时,该字段有值)</p>
884
884
  :rtype: list of HasAuthOrganization
885
885
  """
886
886
  return self._HasAuthOrganizationList
@@ -891,7 +891,7 @@ class AuthInfoDetail(AbstractModel):
891
891
 
892
892
  @property
893
893
  def AuthUserTotal(self):
894
- r"""授权员工列表总数
894
+ r"""<p>授权员工列表总数</p>
895
895
  :rtype: int
896
896
  """
897
897
  return self._AuthUserTotal
@@ -902,7 +902,7 @@ class AuthInfoDetail(AbstractModel):
902
902
 
903
903
  @property
904
904
  def AuthOrganizationTotal(self):
905
- r"""授权企业列表总数
905
+ r"""<p>授权企业列表总数</p>
906
906
  :rtype: int
907
907
  """
908
908
  return self._AuthOrganizationTotal
@@ -982,19 +982,19 @@ class AutoSignConfig(AbstractModel):
982
982
 
983
983
  def __init__(self):
984
984
  r"""
985
- :param _UserInfo: <p>自动签开通个人用户信息, 包括名字,身份证等</p>
985
+ :param _UserInfo: <p>“授权签”开通个人用户信息, 包括名字,身份证等</p>
986
986
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
987
987
  :param _CertInfoCallback: <p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
988
988
  :type CertInfoCallback: bool
989
989
  :param _UserDefineSeal: <p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
990
990
  :type UserDefineSeal: bool
991
- :param _SealImgCallback: <p>回调中是否需要自动签将要使用的印章(签名)图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
991
+ :param _SealImgCallback: <p>回调中是否需要“授权签”将要使用的印章(签名)图片的 base64:<ul><li><strong>false</strong>: 不需要(默认)</li><li><strong>true</strong>: 需要</li></ul></p>
992
992
  :type SealImgCallback: bool
993
993
  :param _CallbackUrl: <p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
994
994
  :type CallbackUrl: str
995
995
  :param _VerifyChannels: <p>开通时候的身份验证方式, 取值为:</p><ul><li>**WEIXINAPP** : 微信人脸识别</li><li>**INSIGHT** : 慧眼人脸识别</li><li>**TELECOM** : 运营商三要素验证</li></ul>注:<ul><li>如果是小程序开通链接,仅支持传 WEIXINAPP。为空默认 WEIXINAPP</li><li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
996
996
  :type VerifyChannels: list of str
997
- :param _LicenseType: <p>设置用户开通自动签时是否绑定个人自动签账号许可。</p><ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
997
+ :param _LicenseType: <p>设置用户开通“授权签”时是否绑定个人“授权签”账号许可。<ul><li><b>1</b>: (默认)不绑定“授权签”账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul>注:<code>该字段已经失效,请勿设置此参数。</code></p>
998
998
  :type LicenseType: int
999
999
  :param _JumpUrl: <p>开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。</p><p>注:<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景:</p><ul><li>**贵方H5 -&gt; 腾讯电子签H5 -&gt; 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -&gt; 腾讯电子签H5 -&gt; 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。<code>APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。</code>APP拦截地址跳转可参考:<a href="https://qian.tencent.com/developers/company/openqianh5/#3-%E8%BF%94%E5%9B%9E%E5%BA%94%E7%94%A8jumpurl%E6%A0%BC%E5%BC%8F">返回应用JumpUrl格式</a> </li></ul><p>成功结果返回:<br>若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:<code>appendResult=qian</code>。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如:qianapp://YOUR_CUSTOM_URL?action=sign&amp;result=success&amp;from=tencent_ess</p>
1000
1000
  :type JumpUrl: str
@@ -1010,7 +1010,7 @@ class AutoSignConfig(AbstractModel):
1010
1010
 
1011
1011
  @property
1012
1012
  def UserInfo(self):
1013
- r"""<p>自动签开通个人用户信息, 包括名字,身份证等</p>
1013
+ r"""<p>“授权签”开通个人用户信息, 包括名字,身份证等</p>
1014
1014
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
1015
1015
  """
1016
1016
  return self._UserInfo
@@ -1043,7 +1043,7 @@ class AutoSignConfig(AbstractModel):
1043
1043
 
1044
1044
  @property
1045
1045
  def SealImgCallback(self):
1046
- r"""<p>回调中是否需要自动签将要使用的印章(签名)图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
1046
+ r"""<p>回调中是否需要“授权签”将要使用的印章(签名)图片的 base64:<ul><li><strong>false</strong>: 不需要(默认)</li><li><strong>true</strong>: 需要</li></ul></p>
1047
1047
  :rtype: bool
1048
1048
  """
1049
1049
  return self._SealImgCallback
@@ -1080,7 +1080,7 @@ class AutoSignConfig(AbstractModel):
1080
1080
 
1081
1081
  @property
1082
1082
  def LicenseType(self):
1083
- r"""<p>设置用户开通自动签时是否绑定个人自动签账号许可。</p><ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
1083
+ r"""<p>设置用户开通“授权签”时是否绑定个人“授权签”账号许可。<ul><li><b>1</b>: (默认)不绑定“授权签”账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul>注:<code>该字段已经失效,请勿设置此参数。</code></p>
1084
1084
  :rtype: int
1085
1085
  """
1086
1086
  return self._LicenseType
@@ -1129,54 +1129,35 @@ class BaseFlowInfo(AbstractModel):
1129
1129
 
1130
1130
  def __init__(self):
1131
1131
  r"""
1132
- :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1132
+ :param _FlowName: <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
1133
1133
  :type FlowName: str
1134
- :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1134
+ :param _Deadline: <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
1135
1135
  :type Deadline: int
1136
- :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
1136
+ :param _FlowType: <p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
1137
1137
  :type FlowType: str
1138
- :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
1138
+ :param _FlowDescription: <p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
1139
1139
  :type FlowDescription: str
1140
- :param _Unordered: 合同流程的签署顺序类型:
1141
- **false**:(默认)有序签署, 本合同多个参与人需要依次签署
1142
- **true**:无序签署, 本合同多个参与人没有先后签署限制
1140
+ :param _Unordered: <p>合同流程的签署顺序类型:<br><strong>false</strong>:(默认)有序签署, 本合同多个参与人需要依次签署<br><strong>true</strong>:无序签署, 本合同多个参与人没有先后签署限制</p>
1143
1141
  :type Unordered: bool
1144
- :param _IntelligentStatus: 是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
1142
+ :param _IntelligentStatus: <p>是否打开智能添加填写区(默认开启,打开:&quot;OPEN&quot; 关闭:&quot;CLOSE&quot;)</p>
1145
1143
  :type IntelligentStatus: str
1146
- :param _FormFields: 填写控件内容, 填写的控制的ID-填写的内容对列表
1144
+ :param _FormFields: <p>填写控件内容, 填写的控制的ID-填写的内容对列表</p>
1147
1145
  :type FormFields: list of FormField
1148
- :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1149
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
1150
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
1151
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1152
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
1153
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
1154
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
1146
+ :param _NeedSignReview: <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:<ul><li> <strong>false</strong>:(默认)不需要审批,直接签署。</li><li> <strong>true</strong>:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、“授权签”合同</code></p>
1155
1147
  :type NeedSignReview: bool
1156
- :param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
1157
-
1158
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
1148
+ :param _UserData: <p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
1159
1149
  :type UserData: str
1160
- :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1161
-
1162
- 注
1163
- 1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
1164
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
1150
+ :param _CcInfos: <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p>注</p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
1165
1151
  :type CcInfos: list of CcInfo
1166
- :param _NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1167
-
1168
- 若设置为true,发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
1169
-
1170
-
1152
+ :param _NeedCreateReview: <p>发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。</p><p>若设置为true,发起审核结果需通过接口 <a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview">提交企业签署流程审批结果</a>通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。</p>
1171
1153
  :type NeedCreateReview: bool
1172
- :param _Components: 填写控件:文件发起使用
1154
+ :param _Components: <p>填写控件:文件发起使用</p>
1173
1155
  :type Components: list of Component
1174
- :param _FlowDisplayType: 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
1175
-
1156
+ :param _FlowDisplayType: <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
1176
1157
  :type FlowDisplayType: int
1177
- :param _FileIds: 签署文件资源Id列表,目前仅支持单个文件
1158
+ :param _FileIds: <p>签署文件资源Id列表,目前仅支持单个文件</p>
1178
1159
  :type FileIds: list of str
1179
- :param _Approvers: 合同签署人信息
1160
+ :param _Approvers: <p>合同签署人信息</p>
1180
1161
  :type Approvers: list of CommonFlowApprover
1181
1162
  """
1182
1163
  self._FlowName = None
@@ -1197,7 +1178,7 @@ class BaseFlowInfo(AbstractModel):
1197
1178
 
1198
1179
  @property
1199
1180
  def FlowName(self):
1200
- r"""合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1181
+ r"""<p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
1201
1182
  :rtype: str
1202
1183
  """
1203
1184
  return self._FlowName
@@ -1208,7 +1189,7 @@ class BaseFlowInfo(AbstractModel):
1208
1189
 
1209
1190
  @property
1210
1191
  def Deadline(self):
1211
- r"""合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1192
+ r"""<p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
1212
1193
  :rtype: int
1213
1194
  """
1214
1195
  return self._Deadline
@@ -1219,7 +1200,7 @@ class BaseFlowInfo(AbstractModel):
1219
1200
 
1220
1201
  @property
1221
1202
  def FlowType(self):
1222
- r"""合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
1203
+ r"""<p>合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。</p>
1223
1204
  :rtype: str
1224
1205
  """
1225
1206
  return self._FlowType
@@ -1230,7 +1211,7 @@ class BaseFlowInfo(AbstractModel):
1230
1211
 
1231
1212
  @property
1232
1213
  def FlowDescription(self):
1233
- r"""合同流程描述信息(可自定义此描述),最大长度1000个字符。
1214
+ r"""<p>合同流程描述信息(可自定义此描述),最大长度1000个字符。</p>
1234
1215
  :rtype: str
1235
1216
  """
1236
1217
  return self._FlowDescription
@@ -1241,9 +1222,7 @@ class BaseFlowInfo(AbstractModel):
1241
1222
 
1242
1223
  @property
1243
1224
  def Unordered(self):
1244
- r"""合同流程的签署顺序类型:
1245
- **false**:(默认)有序签署, 本合同多个参与人需要依次签署
1246
- **true**:无序签署, 本合同多个参与人没有先后签署限制
1225
+ r"""<p>合同流程的签署顺序类型:<br><strong>false</strong>:(默认)有序签署, 本合同多个参与人需要依次签署<br><strong>true</strong>:无序签署, 本合同多个参与人没有先后签署限制</p>
1247
1226
  :rtype: bool
1248
1227
  """
1249
1228
  return self._Unordered
@@ -1254,7 +1233,7 @@ class BaseFlowInfo(AbstractModel):
1254
1233
 
1255
1234
  @property
1256
1235
  def IntelligentStatus(self):
1257
- r"""是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
1236
+ r"""<p>是否打开智能添加填写区(默认开启,打开:&quot;OPEN&quot; 关闭:&quot;CLOSE&quot;)</p>
1258
1237
  :rtype: str
1259
1238
  """
1260
1239
  return self._IntelligentStatus
@@ -1265,7 +1244,7 @@ class BaseFlowInfo(AbstractModel):
1265
1244
 
1266
1245
  @property
1267
1246
  def FormFields(self):
1268
- r"""填写控件内容, 填写的控制的ID-填写的内容对列表
1247
+ r"""<p>填写控件内容, 填写的控制的ID-填写的内容对列表</p>
1269
1248
  :rtype: list of FormField
1270
1249
  """
1271
1250
  return self._FormFields
@@ -1276,13 +1255,7 @@ class BaseFlowInfo(AbstractModel):
1276
1255
 
1277
1256
  @property
1278
1257
  def NeedSignReview(self):
1279
- r"""发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1280
- <ul><li> **false**:(默认)不需要审批,直接签署。</li>
1281
- <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
1282
- 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1283
- <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
1284
- <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
1285
- 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
1258
+ r"""<p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:<ul><li> <strong>false</strong>:(默认)不需要审批,直接签署。</li><li> <strong>true</strong>:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、“授权签”合同</code></p>
1286
1259
  :rtype: bool
1287
1260
  """
1288
1261
  return self._NeedSignReview
@@ -1293,9 +1266,7 @@ class BaseFlowInfo(AbstractModel):
1293
1266
 
1294
1267
  @property
1295
1268
  def UserData(self):
1296
- r"""调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
1297
-
1298
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
1269
+ r"""<p>调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。</p>
1299
1270
  :rtype: str
1300
1271
  """
1301
1272
  return self._UserData
@@ -1306,11 +1277,7 @@ class BaseFlowInfo(AbstractModel):
1306
1277
 
1307
1278
  @property
1308
1279
  def CcInfos(self):
1309
- r"""合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1310
-
1311
- 注
1312
- 1. 抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。
1313
- 2. 请确保抄送人列表中的成员不与任何签署人重复。
1280
+ r"""<p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p>注</p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
1314
1281
  :rtype: list of CcInfo
1315
1282
  """
1316
1283
  return self._CcInfos
@@ -1321,11 +1288,7 @@ class BaseFlowInfo(AbstractModel):
1321
1288
 
1322
1289
  @property
1323
1290
  def NeedCreateReview(self):
1324
- r"""发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1325
-
1326
- 若设置为true,发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
1327
-
1328
-
1291
+ r"""<p>发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。</p><p>若设置为true,发起审核结果需通过接口 <a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview">提交企业签署流程审批结果</a>通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。</p>
1329
1292
  :rtype: bool
1330
1293
  """
1331
1294
  return self._NeedCreateReview
@@ -1336,7 +1299,7 @@ class BaseFlowInfo(AbstractModel):
1336
1299
 
1337
1300
  @property
1338
1301
  def Components(self):
1339
- r"""填写控件:文件发起使用
1302
+ r"""<p>填写控件:文件发起使用</p>
1340
1303
  :rtype: list of Component
1341
1304
  """
1342
1305
  return self._Components
@@ -1347,8 +1310,7 @@ class BaseFlowInfo(AbstractModel):
1347
1310
 
1348
1311
  @property
1349
1312
  def FlowDisplayType(self):
1350
- r"""在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
1351
-
1313
+ r"""<p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
1352
1314
  :rtype: int
1353
1315
  """
1354
1316
  return self._FlowDisplayType
@@ -1359,7 +1321,7 @@ class BaseFlowInfo(AbstractModel):
1359
1321
 
1360
1322
  @property
1361
1323
  def FileIds(self):
1362
- r"""签署文件资源Id列表,目前仅支持单个文件
1324
+ r"""<p>签署文件资源Id列表,目前仅支持单个文件</p>
1363
1325
  :rtype: list of str
1364
1326
  """
1365
1327
  return self._FileIds
@@ -1370,7 +1332,7 @@ class BaseFlowInfo(AbstractModel):
1370
1332
 
1371
1333
  @property
1372
1334
  def Approvers(self):
1373
- r"""合同签署人信息
1335
+ r"""<p>合同签署人信息</p>
1374
1336
  :rtype: list of CommonFlowApprover
1375
1337
  """
1376
1338
  return self._Approvers
@@ -2614,14 +2576,13 @@ class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
2614
2576
 
2615
2577
  def __init__(self):
2616
2578
  r"""
2617
- :param _Agent: 渠道应用相关信息
2579
+ :param _Agent: <p>渠道应用相关信息</p>
2618
2580
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2619
- :param _Operator: 操作人信息
2581
+ :param _Operator: <p>操作人信息</p>
2620
2582
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
2621
- :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
2622
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
2583
+ :param _SceneKey: <p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
2623
2584
  :type SceneKey: str
2624
- :param _UserInfo: 指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
2585
+ :param _UserInfo: <p>指定撤销链接的用户信息,包含姓名、证件类型、证件号码。</p>
2625
2586
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
2626
2587
  """
2627
2588
  self._Agent = None
@@ -2631,7 +2592,7 @@ class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
2631
2592
 
2632
2593
  @property
2633
2594
  def Agent(self):
2634
- r"""渠道应用相关信息
2595
+ r"""<p>渠道应用相关信息</p>
2635
2596
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2636
2597
  """
2637
2598
  return self._Agent
@@ -2642,7 +2603,7 @@ class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
2642
2603
 
2643
2604
  @property
2644
2605
  def Operator(self):
2645
- r"""操作人信息
2606
+ r"""<p>操作人信息</p>
2646
2607
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
2647
2608
  """
2648
2609
  return self._Operator
@@ -2653,8 +2614,7 @@ class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
2653
2614
 
2654
2615
  @property
2655
2616
  def SceneKey(self):
2656
- r"""自动签使用的场景值, 可以选择的场景值如下:
2657
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
2617
+ r"""<p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
2658
2618
  :rtype: str
2659
2619
  """
2660
2620
  return self._SceneKey
@@ -2665,7 +2625,7 @@ class ChannelCancelUserAutoSignEnableUrlRequest(AbstractModel):
2665
2625
 
2666
2626
  @property
2667
2627
  def UserInfo(self):
2668
- r"""指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
2628
+ r"""<p>指定撤销链接的用户信息,包含姓名、证件类型、证件号码。</p>
2669
2629
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
2670
2630
  """
2671
2631
  return self._UserInfo
@@ -7167,45 +7127,23 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7167
7127
 
7168
7128
  def __init__(self):
7169
7129
  r"""
7170
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7171
-
7172
- 此接口下面信息必填。
7173
- <ul>
7174
- <li>渠道应用标识: Agent.AppId</li>
7175
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7176
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
7177
- </ul>
7178
- 第三方平台子客企业和员工必须已经经过实名认证
7130
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
7179
7131
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7180
- :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
7181
-
7182
-
7183
- [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
7132
+ :param _NeedRelievedFlowId: <p>待解除的签署流程编号(即原签署流程的编号)。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png">点击查看流程编号在控制台上的位置</a></p>
7184
7133
  :type NeedRelievedFlowId: str
7185
- :param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
7134
+ :param _ReliveInfo: <p>解除协议内容, 包括解除理由等信息。</p>
7186
7135
  :type ReliveInfo: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
7187
- :param _ReleasedApprovers: 替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
7188
- 如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
7189
-
7190
- 注:
7191
- 1. 支持更换企业的签署人,不支持更换个人类型的签署人。
7192
- 2. 己方企业支持自动签署,他方企业不支持自动签署。
7193
- 3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。
7136
+ :param _ReleasedApprovers: <p>替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br><br>如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br></p><p>注:</p><ol><li>支持更换企业的签署人,不支持更换个人类型的签署人。</li><li>己方企业支持授权签署,他方企业不支持授权签署。</li><li><b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。</li></ol>
7194
7137
  :type ReleasedApprovers: list of ReleasedApprover
7195
- :param _CallbackUrl: 签署完回调url,最大长度1000个字符
7138
+ :param _CallbackUrl: <p>签署完回调url,最大长度1000个字符</p>
7196
7139
  :type CallbackUrl: str
7197
- :param _Organization: 暂未开放
7140
+ :param _Organization: <p>暂未开放</p>
7198
7141
  :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
7199
- :param _Operator: 暂未开放
7142
+ :param _Operator: <p>暂未开放</p>
7200
7143
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
7201
- :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
7202
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
7144
+ :param _Deadline: <p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
7203
7145
  :type Deadline: int
7204
- :param _UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
7205
-
7206
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
7207
-
7208
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
7146
+ :param _UserData: <p>调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。</p><p>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
7209
7147
  :type UserData: str
7210
7148
  """
7211
7149
  self._Agent = None
@@ -7220,15 +7158,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7220
7158
 
7221
7159
  @property
7222
7160
  def Agent(self):
7223
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7224
-
7225
- 此接口下面信息必填。
7226
- <ul>
7227
- <li>渠道应用标识: Agent.AppId</li>
7228
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7229
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
7230
- </ul>
7231
- 第三方平台子客企业和员工必须已经经过实名认证
7161
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
7232
7162
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7233
7163
  """
7234
7164
  return self._Agent
@@ -7239,10 +7169,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7239
7169
 
7240
7170
  @property
7241
7171
  def NeedRelievedFlowId(self):
7242
- r"""待解除的签署流程编号(即原签署流程的编号)。
7243
-
7244
-
7245
- [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
7172
+ r"""<p>待解除的签署流程编号(即原签署流程的编号)。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png">点击查看流程编号在控制台上的位置</a></p>
7246
7173
  :rtype: str
7247
7174
  """
7248
7175
  return self._NeedRelievedFlowId
@@ -7253,7 +7180,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7253
7180
 
7254
7181
  @property
7255
7182
  def ReliveInfo(self):
7256
- r"""解除协议内容, 包括解除理由等信息。
7183
+ r"""<p>解除协议内容, 包括解除理由等信息。</p>
7257
7184
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.RelieveInfo`
7258
7185
  """
7259
7186
  return self._ReliveInfo
@@ -7264,13 +7191,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7264
7191
 
7265
7192
  @property
7266
7193
  def ReleasedApprovers(self):
7267
- r"""替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br/>
7268
- 如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
7269
-
7270
- 注:
7271
- 1. 支持更换企业的签署人,不支持更换个人类型的签署人。
7272
- 2. 己方企业支持自动签署,他方企业不支持自动签署。
7273
- 3. <b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。
7194
+ r"""<p>替换解除协议的签署人, 如不指定新的签署人,将继续使用原流程的签署人作为本解除协议的参与方。 <br><br>如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br></p><p>注:</p><ol><li>支持更换企业的签署人,不支持更换个人类型的签署人。</li><li>己方企业支持授权签署,他方企业不支持授权签署。</li><li><b>仅将需要替换的签署人添加至此列表</b>,无需替换的签署人无需添加进来。</li></ol>
7274
7195
  :rtype: list of ReleasedApprover
7275
7196
  """
7276
7197
  return self._ReleasedApprovers
@@ -7283,7 +7204,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7283
7204
  def CallbackUrl(self):
7284
7205
  warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
7285
7206
 
7286
- r"""签署完回调url,最大长度1000个字符
7207
+ r"""<p>签署完回调url,最大长度1000个字符</p>
7287
7208
  :rtype: str
7288
7209
  """
7289
7210
  return self._CallbackUrl
@@ -7298,7 +7219,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7298
7219
  def Organization(self):
7299
7220
  warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
7300
7221
 
7301
- r"""暂未开放
7222
+ r"""<p>暂未开放</p>
7302
7223
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
7303
7224
  """
7304
7225
  return self._Organization
@@ -7313,7 +7234,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7313
7234
  def Operator(self):
7314
7235
  warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
7315
7236
 
7316
- r"""暂未开放
7237
+ r"""<p>暂未开放</p>
7317
7238
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
7318
7239
  """
7319
7240
  return self._Operator
@@ -7326,8 +7247,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7326
7247
 
7327
7248
  @property
7328
7249
  def Deadline(self):
7329
- r"""合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
7330
- 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
7250
+ r"""<p>合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。<br>如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。</p>
7331
7251
  :rtype: int
7332
7252
  """
7333
7253
  return self._Deadline
@@ -7338,11 +7258,7 @@ class ChannelCreateReleaseFlowRequest(AbstractModel):
7338
7258
 
7339
7259
  @property
7340
7260
  def UserData(self):
7341
- r"""调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
7342
-
7343
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
7344
-
7345
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
7261
+ r"""<p>调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。</p><p>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。</p><p>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
7346
7262
  :rtype: str
7347
7263
  """
7348
7264
  return self._UserData
@@ -7392,7 +7308,7 @@ class ChannelCreateReleaseFlowResponse(AbstractModel):
7392
7308
 
7393
7309
  def __init__(self):
7394
7310
  r"""
7395
- :param _FlowId: 解除协议流程编号
7311
+ :param _FlowId: <p>解除协议流程编号</p>
7396
7312
  :type FlowId: str
7397
7313
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7398
7314
  :type RequestId: str
@@ -7402,7 +7318,7 @@ class ChannelCreateReleaseFlowResponse(AbstractModel):
7402
7318
 
7403
7319
  @property
7404
7320
  def FlowId(self):
7405
- r"""解除协议流程编号
7321
+ r"""<p>解除协议流程编号</p>
7406
7322
  :rtype: str
7407
7323
  """
7408
7324
  return self._FlowId
@@ -7819,11 +7735,11 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
7819
7735
  r"""
7820
7736
  :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
7821
7737
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
7822
- :param _SceneKey: <p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
7738
+ :param _SceneKey: <p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
7823
7739
  :type SceneKey: str
7824
7740
  :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
7825
7741
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
7826
- :param _AutoSignConfig: <p>自动签开通配置信息, 包括开通的人员的信息等</p>
7742
+ :param _AutoSignConfig: <p>授权签开通配置信息, 包括开通的人员的信息等</p>
7827
7743
  :type AutoSignConfig: :class:`tencentcloud.essbasic.v20210526.models.AutoSignConfig`
7828
7744
  :param _UrlType: <p>生成的链接类型:</p><ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li><li> **H5SIGN** : 生成H5端开通链接</li></ul>
7829
7745
  :type UrlType: str
@@ -7833,7 +7749,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
7833
7749
  :type NotifyAddress: str
7834
7750
  :param _ExpiredTime: <p>链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。<code>如果不传,默认过期时间为当前时间往后7天。</code></p>
7835
7751
  :type ExpiredTime: int
7836
- :param _UserData: <p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。</p>
7752
+ :param _UserData: <p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人授权签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。</p>
7837
7753
  :type UserData: str
7838
7754
  :param _EndPoint: <p>要跳转的链接类型<ul><li> <strong>HTTP</strong>:跳转电子签小程序或者H5的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链</li><li><strong>HTTP_SHORT_URL</strong>:跳转电子签小程序或者H5的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li><strong>APP</strong>: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型,注意:仅UrlType为空,即获取小程序端开通链接时有效</li></ul></p>
7839
7755
  :type EndPoint: str
@@ -7862,7 +7778,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
7862
7778
 
7863
7779
  @property
7864
7780
  def SceneKey(self):
7865
- r"""<p>自动签使用的场景值, 可以选择的场景值如下:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
7781
+ r"""<p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
7866
7782
  :rtype: str
7867
7783
  """
7868
7784
  return self._SceneKey
@@ -7884,7 +7800,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
7884
7800
 
7885
7801
  @property
7886
7802
  def AutoSignConfig(self):
7887
- r"""<p>自动签开通配置信息, 包括开通的人员的信息等</p>
7803
+ r"""<p>授权签开通配置信息, 包括开通的人员的信息等</p>
7888
7804
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.AutoSignConfig`
7889
7805
  """
7890
7806
  return self._AutoSignConfig
@@ -7939,7 +7855,7 @@ class ChannelCreateUserAutoSignEnableUrlRequest(AbstractModel):
7939
7855
 
7940
7856
  @property
7941
7857
  def UserData(self):
7942
- r"""<p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。</p>
7858
+ r"""<p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人授权签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。</p>
7943
7859
  :rtype: str
7944
7860
  """
7945
7861
  return self._UserData
@@ -7994,7 +7910,7 @@ class ChannelCreateUserAutoSignEnableUrlResponse(AbstractModel):
7994
7910
 
7995
7911
  def __init__(self):
7996
7912
  r"""
7997
- :param _Url: <p>个人用户自动签的开通链接, 短链或者长链接形式。过期时间受 <code>ExpiredTime</code> 参数控制。</p>
7913
+ :param _Url: <p>个人用户授权签的开通链接, 短链或者长链接形式。过期时间受 <code>ExpiredTime</code> 参数控制。</p>
7998
7914
  :type Url: str
7999
7915
  :param _AppId: <p>腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用</p><p>注: <code>如果获取的是H5链接, 则不会返回此值</code></p>
8000
7916
  :type AppId: str
@@ -8019,7 +7935,7 @@ class ChannelCreateUserAutoSignEnableUrlResponse(AbstractModel):
8019
7935
 
8020
7936
  @property
8021
7937
  def Url(self):
8022
- r"""<p>个人用户自动签的开通链接, 短链或者长链接形式。过期时间受 <code>ExpiredTime</code> 参数控制。</p>
7938
+ r"""<p>个人用户授权签的开通链接, 短链或者长链接形式。过期时间受 <code>ExpiredTime</code> 参数控制。</p>
8023
7939
  :rtype: str
8024
7940
  """
8025
7941
  return self._Url
@@ -8114,7 +8030,7 @@ class ChannelCreateUserAutoSignSealUrlRequest(AbstractModel):
8114
8030
  r"""
8115
8031
  :param _Agent: <p>渠道应用相关信息。</p>
8116
8032
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
8117
- :param _SceneKey: <p>“授权签”使用的场景值, 可以选择的场景值如下:<ul><li> <strong>E_PRESCRIPTION_AUTO_SIGN</strong> : 电子处方场景</li><li> <strong>OTHER</strong> : 通用场景</li></ul></p>
8033
+ :param _SceneKey: <p>“授权签”使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
8118
8034
  :type SceneKey: str
8119
8035
  :param _UserInfo: <p>“授权签”开通个人用户信息,包括名字,身份证等。</p>
8120
8036
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
@@ -8145,7 +8061,7 @@ class ChannelCreateUserAutoSignSealUrlRequest(AbstractModel):
8145
8061
 
8146
8062
  @property
8147
8063
  def SceneKey(self):
8148
- r"""<p>“授权签”使用的场景值, 可以选择的场景值如下:<ul><li> <strong>E_PRESCRIPTION_AUTO_SIGN</strong> : 电子处方场景</li><li> <strong>OTHER</strong> : 通用场景</li></ul></p>
8064
+ r"""<p>“授权签”使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
8149
8065
  :rtype: str
8150
8066
  """
8151
8067
  return self._SceneKey
@@ -9865,38 +9781,15 @@ class ChannelDescribeRolesRequest(AbstractModel):
9865
9781
 
9866
9782
  def __init__(self):
9867
9783
  r"""
9868
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
9869
-
9870
- 此接口下面信息必填。
9871
- <ul>
9872
- <li>渠道应用标识: Agent.AppId</li>
9873
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
9874
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
9875
- </ul>
9876
- 第三方平台子客企业和员工必须已经经过实名认证
9784
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
9877
9785
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9878
- :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
9879
-
9880
- 注: `因为历史原因, 此字段为字符串类型`
9786
+ :param _Limit: <p>指定每页返回的数据条数,和Offset参数配合使用,单页最大200。</p><p>注: <code>因为历史原因, 此字段为字符串类型</code></p>
9881
9787
  :type Limit: str
9882
- :param _Filters: 查询的关键字段:
9883
- Key:"**RoleType**",Values:["**1**"]查询系统角色,
9884
- Key:"**RoleType**",Values:["**2**"]查询自定义角色
9885
- Key:"**RoleStatus**",Values:["**1**"]查询启用角色
9886
- Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
9887
- Key:"**IsReturnPermissionGroup**",Values:["**0**"]表示接口不返回角色对应的权限树字段
9888
- Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对应的权限树字段
9889
-
9890
- 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
9891
-
9788
+ :param _Filters: <p>查询的关键字段:<br>Key:&quot;<strong>RoleType</strong>&quot;,Values:[&quot;<strong>1</strong>&quot;]查询系统角色,<br>Key:&quot;<strong>RoleType</strong>&quot;,Values:[&quot;<strong>2</strong>&quot;]查询自定义角色<br>Key:&quot;<strong>RoleStatus</strong>&quot;,Values:[&quot;<strong>1</strong>&quot;]查询启用角色<br>Key:&quot;<strong>RoleStatus</strong>&quot;,Values:[&quot;<strong>2</strong>&quot;]查询禁用角色<br>Key:&quot;<strong>IsReturnPermissionGroup</strong>&quot;,Values:[&quot;<strong>0</strong>&quot;]表示接口不返回角色对应的权限树字段<br>Key:&quot;<strong>IsReturnPermissionGroup</strong>&quot;,Values:[&quot;<strong>1</strong>&quot;]表示接口返回角色对应的权限树字段</p><p>注: <code>同名字的Key的过滤条件会冲突, 只能填写一个</code></p>
9892
9789
  :type Filters: list of Filter
9893
- :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
9894
-
9895
- 注:
9896
- 1.`offset从0开始,即第一页为0。`
9897
- 2.`默认从第一页返回。`
9790
+ :param _Offset: <p>查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。</p><p>注:<br>1.<code>offset从0开始,即第一页为0。</code><br>2.<code>默认从第一页返回。</code></p>
9898
9791
  :type Offset: int
9899
- :param _Operator: 操作人信息
9792
+ :param _Operator: <p>操作人信息</p>
9900
9793
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
9901
9794
  """
9902
9795
  self._Agent = None
@@ -9907,15 +9800,7 @@ Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对
9907
9800
 
9908
9801
  @property
9909
9802
  def Agent(self):
9910
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
9911
-
9912
- 此接口下面信息必填。
9913
- <ul>
9914
- <li>渠道应用标识: Agent.AppId</li>
9915
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
9916
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
9917
- </ul>
9918
- 第三方平台子客企业和员工必须已经经过实名认证
9803
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
9919
9804
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9920
9805
  """
9921
9806
  return self._Agent
@@ -9926,9 +9811,7 @@ Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对
9926
9811
 
9927
9812
  @property
9928
9813
  def Limit(self):
9929
- r"""指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
9930
-
9931
- 注: `因为历史原因, 此字段为字符串类型`
9814
+ r"""<p>指定每页返回的数据条数,和Offset参数配合使用,单页最大200。</p><p>注: <code>因为历史原因, 此字段为字符串类型</code></p>
9932
9815
  :rtype: str
9933
9816
  """
9934
9817
  return self._Limit
@@ -9939,16 +9822,7 @@ Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对
9939
9822
 
9940
9823
  @property
9941
9824
  def Filters(self):
9942
- r"""查询的关键字段:
9943
- Key:"**RoleType**",Values:["**1**"]查询系统角色,
9944
- Key:"**RoleType**",Values:["**2**"]查询自定义角色
9945
- Key:"**RoleStatus**",Values:["**1**"]查询启用角色
9946
- Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
9947
- Key:"**IsReturnPermissionGroup**",Values:["**0**"]表示接口不返回角色对应的权限树字段
9948
- Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对应的权限树字段
9949
-
9950
- 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
9951
-
9825
+ r"""<p>查询的关键字段:<br>Key:&quot;<strong>RoleType</strong>&quot;,Values:[&quot;<strong>1</strong>&quot;]查询系统角色,<br>Key:&quot;<strong>RoleType</strong>&quot;,Values:[&quot;<strong>2</strong>&quot;]查询自定义角色<br>Key:&quot;<strong>RoleStatus</strong>&quot;,Values:[&quot;<strong>1</strong>&quot;]查询启用角色<br>Key:&quot;<strong>RoleStatus</strong>&quot;,Values:[&quot;<strong>2</strong>&quot;]查询禁用角色<br>Key:&quot;<strong>IsReturnPermissionGroup</strong>&quot;,Values:[&quot;<strong>0</strong>&quot;]表示接口不返回角色对应的权限树字段<br>Key:&quot;<strong>IsReturnPermissionGroup</strong>&quot;,Values:[&quot;<strong>1</strong>&quot;]表示接口返回角色对应的权限树字段</p><p>注: <code>同名字的Key的过滤条件会冲突, 只能填写一个</code></p>
9952
9826
  :rtype: list of Filter
9953
9827
  """
9954
9828
  return self._Filters
@@ -9959,11 +9833,7 @@ Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对
9959
9833
 
9960
9834
  @property
9961
9835
  def Offset(self):
9962
- r"""查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
9963
-
9964
- 注:
9965
- 1.`offset从0开始,即第一页为0。`
9966
- 2.`默认从第一页返回。`
9836
+ r"""<p>查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。</p><p>注:<br>1.<code>offset从0开始,即第一页为0。</code><br>2.<code>默认从第一页返回。</code></p>
9967
9837
  :rtype: int
9968
9838
  """
9969
9839
  return self._Offset
@@ -9976,7 +9846,7 @@ Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对
9976
9846
  def Operator(self):
9977
9847
  warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
9978
9848
 
9979
- r"""操作人信息
9849
+ r"""<p>操作人信息</p>
9980
9850
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
9981
9851
  """
9982
9852
  return self._Operator
@@ -10020,13 +9890,13 @@ class ChannelDescribeRolesResponse(AbstractModel):
10020
9890
 
10021
9891
  def __init__(self):
10022
9892
  r"""
10023
- :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
9893
+ :param _Offset: <p>查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。</p>
10024
9894
  :type Offset: int
10025
- :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
9895
+ :param _Limit: <p>指定每页返回的数据条数,和Offset参数配合使用,单页最大200。</p>
10026
9896
  :type Limit: int
10027
- :param _TotalCount: 查询角色的总数量
9897
+ :param _TotalCount: <p>查询角色的总数量</p>
10028
9898
  :type TotalCount: int
10029
- :param _ChannelRoles: 查询的角色信息列表
9899
+ :param _ChannelRoles: <p>查询的角色信息列表</p>
10030
9900
  :type ChannelRoles: list of ChannelRole
10031
9901
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10032
9902
  :type RequestId: str
@@ -10039,7 +9909,7 @@ class ChannelDescribeRolesResponse(AbstractModel):
10039
9909
 
10040
9910
  @property
10041
9911
  def Offset(self):
10042
- r"""查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
9912
+ r"""<p>查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。</p>
10043
9913
  :rtype: int
10044
9914
  """
10045
9915
  return self._Offset
@@ -10050,7 +9920,7 @@ class ChannelDescribeRolesResponse(AbstractModel):
10050
9920
 
10051
9921
  @property
10052
9922
  def Limit(self):
10053
- r"""指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
9923
+ r"""<p>指定每页返回的数据条数,和Offset参数配合使用,单页最大200。</p>
10054
9924
  :rtype: int
10055
9925
  """
10056
9926
  return self._Limit
@@ -10061,7 +9931,7 @@ class ChannelDescribeRolesResponse(AbstractModel):
10061
9931
 
10062
9932
  @property
10063
9933
  def TotalCount(self):
10064
- r"""查询角色的总数量
9934
+ r"""<p>查询角色的总数量</p>
10065
9935
  :rtype: int
10066
9936
  """
10067
9937
  return self._TotalCount
@@ -10072,7 +9942,7 @@ class ChannelDescribeRolesResponse(AbstractModel):
10072
9942
 
10073
9943
  @property
10074
9944
  def ChannelRoles(self):
10075
- r"""查询的角色信息列表
9945
+ r"""<p>查询的角色信息列表</p>
10076
9946
  :rtype: list of ChannelRole
10077
9947
  """
10078
9948
  return self._ChannelRoles
@@ -10262,15 +10132,13 @@ class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
10262
10132
 
10263
10133
  def __init__(self):
10264
10134
  r"""
10265
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
10135
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
10266
10136
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10267
- :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
10268
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
10137
+ :param _SceneKey: <p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
10269
10138
  :type SceneKey: str
10270
- :param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
10139
+ :param _UserInfo: <p>要查询状态的用户信息, 包括名字,身份证等</p>
10271
10140
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
10272
- :param _Operator: 执行本接口操作的员工信息。
10273
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10141
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10274
10142
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
10275
10143
  """
10276
10144
  self._Agent = None
@@ -10280,7 +10148,7 @@ class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
10280
10148
 
10281
10149
  @property
10282
10150
  def Agent(self):
10283
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
10151
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
10284
10152
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10285
10153
  """
10286
10154
  return self._Agent
@@ -10291,8 +10159,7 @@ class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
10291
10159
 
10292
10160
  @property
10293
10161
  def SceneKey(self):
10294
- r"""自动签使用的场景值, 可以选择的场景值如下:
10295
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
10162
+ r"""<p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
10296
10163
  :rtype: str
10297
10164
  """
10298
10165
  return self._SceneKey
@@ -10303,7 +10170,7 @@ class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
10303
10170
 
10304
10171
  @property
10305
10172
  def UserInfo(self):
10306
- r"""要查询状态的用户信息, 包括名字,身份证等
10173
+ r"""<p>要查询状态的用户信息, 包括名字,身份证等</p>
10307
10174
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
10308
10175
  """
10309
10176
  return self._UserInfo
@@ -10314,8 +10181,7 @@ class ChannelDescribeUserAutoSignStatusRequest(AbstractModel):
10314
10181
 
10315
10182
  @property
10316
10183
  def Operator(self):
10317
- r"""执行本接口操作的员工信息。
10318
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10184
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10319
10185
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
10320
10186
  """
10321
10187
  return self._Operator
@@ -10353,19 +10219,15 @@ class ChannelDescribeUserAutoSignStatusResponse(AbstractModel):
10353
10219
 
10354
10220
  def __init__(self):
10355
10221
  r"""
10356
- :param _IsOpen: 查询用户是否已开通自动签
10222
+ :param _IsOpen: <p>查询用户是否已开通授权签</p>
10357
10223
  :type IsOpen: bool
10358
- :param _LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
10359
-
10360
- 值为unix时间戳,单位为秒。
10224
+ :param _LicenseFrom: <p>授权签许可生效时间。当且仅当已通过许可开通授权签时有值。</p><p>值为unix时间戳,单位为秒。</p>
10361
10225
  :type LicenseFrom: int
10362
- :param _LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
10363
-
10364
- 值为unix时间戳,单位为秒。
10226
+ :param _LicenseTo: <p>授权签许可到期时间。当且仅当已通过许可开通授权签时有值。</p><p>值为unix时间戳,单位为秒。</p>
10365
10227
  :type LicenseTo: int
10366
- :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li><li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
10228
+ :param _LicenseType: <p>设置用户开通授权签时是否绑定个人授权签账号许可。</p><p>枚举值:</p><ul><li>0: 使用个人授权签账号许可进行开通,个人授权签账号许可有效期1年,注: <code>不可解绑释放更换他人</code></li><li>1: 不绑定授权签账号许可开通,后续使用合同份额进行合同发起</li></ul>
10367
10229
  :type LicenseType: int
10368
- :param _SealId: 用户开通自动签指定使用的印章,为空则未设置印章,需重新进入开通链接设置印章。
10230
+ :param _SealId: <p>用户开通授权签指定使用的印章,为空则未设置印章,需重新进入开通链接设置印章。</p>
10369
10231
  :type SealId: str
10370
10232
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
10371
10233
  :type RequestId: str
@@ -10379,7 +10241,7 @@ class ChannelDescribeUserAutoSignStatusResponse(AbstractModel):
10379
10241
 
10380
10242
  @property
10381
10243
  def IsOpen(self):
10382
- r"""查询用户是否已开通自动签
10244
+ r"""<p>查询用户是否已开通授权签</p>
10383
10245
  :rtype: bool
10384
10246
  """
10385
10247
  return self._IsOpen
@@ -10390,9 +10252,7 @@ class ChannelDescribeUserAutoSignStatusResponse(AbstractModel):
10390
10252
 
10391
10253
  @property
10392
10254
  def LicenseFrom(self):
10393
- r"""自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
10394
-
10395
- 值为unix时间戳,单位为秒。
10255
+ r"""<p>授权签许可生效时间。当且仅当已通过许可开通授权签时有值。</p><p>值为unix时间戳,单位为秒。</p>
10396
10256
  :rtype: int
10397
10257
  """
10398
10258
  return self._LicenseFrom
@@ -10403,9 +10263,7 @@ class ChannelDescribeUserAutoSignStatusResponse(AbstractModel):
10403
10263
 
10404
10264
  @property
10405
10265
  def LicenseTo(self):
10406
- r"""自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
10407
-
10408
- 值为unix时间戳,单位为秒。
10266
+ r"""<p>授权签许可到期时间。当且仅当已通过许可开通授权签时有值。</p><p>值为unix时间戳,单位为秒。</p>
10409
10267
  :rtype: int
10410
10268
  """
10411
10269
  return self._LicenseTo
@@ -10416,7 +10274,7 @@ class ChannelDescribeUserAutoSignStatusResponse(AbstractModel):
10416
10274
 
10417
10275
  @property
10418
10276
  def LicenseType(self):
10419
- r"""设置用户开通自动签时是否绑定个人自动签账号许可。<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li><li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
10277
+ r"""<p>设置用户开通授权签时是否绑定个人授权签账号许可。</p><p>枚举值:</p><ul><li>0: 使用个人授权签账号许可进行开通,个人授权签账号许可有效期1年,注: <code>不可解绑释放更换他人</code></li><li>1: 不绑定授权签账号许可开通,后续使用合同份额进行合同发起</li></ul>
10420
10278
  :rtype: int
10421
10279
  """
10422
10280
  return self._LicenseType
@@ -10427,7 +10285,7 @@ class ChannelDescribeUserAutoSignStatusResponse(AbstractModel):
10427
10285
 
10428
10286
  @property
10429
10287
  def SealId(self):
10430
- r"""用户开通自动签指定使用的印章,为空则未设置印章,需重新进入开通链接设置印章。
10288
+ r"""<p>用户开通授权签指定使用的印章,为空则未设置印章,需重新进入开通链接设置印章。</p>
10431
10289
  :rtype: str
10432
10290
  """
10433
10291
  return self._SealId
@@ -10464,15 +10322,13 @@ class ChannelDisableUserAutoSignRequest(AbstractModel):
10464
10322
 
10465
10323
  def __init__(self):
10466
10324
  r"""
10467
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
10325
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
10468
10326
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10469
- :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
10470
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
10327
+ :param _SceneKey: <p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
10471
10328
  :type SceneKey: str
10472
- :param _UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
10329
+ :param _UserInfo: <p>需要关闭授权签的个人的信息,如姓名,证件信息等。</p>
10473
10330
  :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
10474
- :param _Operator: 执行本接口操作的员工信息。
10475
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10331
+ :param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10476
10332
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
10477
10333
  """
10478
10334
  self._Agent = None
@@ -10482,7 +10338,7 @@ class ChannelDisableUserAutoSignRequest(AbstractModel):
10482
10338
 
10483
10339
  @property
10484
10340
  def Agent(self):
10485
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
10341
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
10486
10342
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
10487
10343
  """
10488
10344
  return self._Agent
@@ -10493,8 +10349,7 @@ class ChannelDisableUserAutoSignRequest(AbstractModel):
10493
10349
 
10494
10350
  @property
10495
10351
  def SceneKey(self):
10496
- r"""自动签使用的场景值, 可以选择的场景值如下:
10497
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
10352
+ r"""<p>授权签使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul>
10498
10353
  :rtype: str
10499
10354
  """
10500
10355
  return self._SceneKey
@@ -10505,7 +10360,7 @@ class ChannelDisableUserAutoSignRequest(AbstractModel):
10505
10360
 
10506
10361
  @property
10507
10362
  def UserInfo(self):
10508
- r"""需要关闭自动签的个人的信息,如姓名,证件信息等。
10363
+ r"""<p>需要关闭授权签的个人的信息,如姓名,证件信息等。</p>
10509
10364
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
10510
10365
  """
10511
10366
  return self._UserInfo
@@ -10516,8 +10371,7 @@ class ChannelDisableUserAutoSignRequest(AbstractModel):
10516
10371
 
10517
10372
  @property
10518
10373
  def Operator(self):
10519
- r"""执行本接口操作的员工信息。
10520
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
10374
+ r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
10521
10375
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
10522
10376
  """
10523
10377
  return self._Operator
@@ -11696,13 +11550,13 @@ class CommonFlowApprover(AbstractModel):
11696
11550
  r"""
11697
11551
  :param _NotChannelOrganization: <p>指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。</p><ul><li>false: 默认值,第三方平台子客企业下员工</li><li>true: SaaS平台企业下的员工</li></ul>
11698
11552
  :type NotChannelOrganization: bool
11699
- :param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:</p><p> <strong>0</strong> :企业/企业员工(企业签署方或模板发起时的企业静默签)<br> <strong>1</strong> :个人/自然人<br><strong>3</strong> :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</p><p>注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。<br>使用自动签时,请确保企业已经开通自动签功能,开通方式:控制台 -&gt; 企业设置 -&gt; 扩展服务 -&gt; 企业自动签。<br>使用文件发起自动签时使用前请联系对接的客户经理沟通。</p>
11553
+ :param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下: <strong>0</strong> :企业/企业员工(企业签署方或模板发起时的企业“授权签”) <strong>1</strong> :个人/自然人<strong>3</strong> :企业/企业员工“授权签”(他方企业“授权签”或文件发起时的本方企业“授权签”)注:类型为3(企业/企业员工“授权签”)时,此接口会默认完成该签署方的签署。“授权签”仅进行盖章操作,不能“授权签”名。使用“授权签”时,请确保企业已经开通“授权签”功能,开通方式:控制台 -&gt; 企业设置 -&gt; 扩展服务 -&gt; 企业“授权签”。使用文件发起“授权签”时使用前请联系对接的客户经理沟通。</p>
11700
11554
  :type ApproverType: int
11701
11555
  :param _OrganizationId: <p>电子签平台给企业生成的企业id</p>
11702
11556
  :type OrganizationId: str
11703
- :param _OrganizationOpenId: <p>企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传</p>
11557
+ :param _OrganizationOpenId: <p>企业OpenId,第三方应用集成非“授权签”子客企业签署人发起合同必传</p>
11704
11558
  :type OrganizationOpenId: str
11705
- :param _OrganizationName: <p>企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传</p>
11559
+ :param _OrganizationName: <p>企业名称,第三方应用集成非“授权签”子客企业签署人必传,saas企业签署人必传</p>
11706
11560
  :type OrganizationName: str
11707
11561
  :param _UserId: <p>电子签平台给企业员工或者自热人生成的用户id</p>
11708
11562
  :type UserId: str
@@ -11769,7 +11623,7 @@ class CommonFlowApprover(AbstractModel):
11769
11623
 
11770
11624
  @property
11771
11625
  def ApproverType(self):
11772
- r"""<p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:</p><p> <strong>0</strong> :企业/企业员工(企业签署方或模板发起时的企业静默签)<br> <strong>1</strong> :个人/自然人<br><strong>3</strong> :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</p><p>注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。<br>使用自动签时,请确保企业已经开通自动签功能,开通方式:控制台 -&gt; 企业设置 -&gt; 扩展服务 -&gt; 企业自动签。<br>使用文件发起自动签时使用前请联系对接的客户经理沟通。</p>
11626
+ r"""<p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下: <strong>0</strong> :企业/企业员工(企业签署方或模板发起时的企业“授权签”) <strong>1</strong> :个人/自然人<strong>3</strong> :企业/企业员工“授权签”(他方企业“授权签”或文件发起时的本方企业“授权签”)注:类型为3(企业/企业员工“授权签”)时,此接口会默认完成该签署方的签署。“授权签”仅进行盖章操作,不能“授权签”名。使用“授权签”时,请确保企业已经开通“授权签”功能,开通方式:控制台 -&gt; 企业设置 -&gt; 扩展服务 -&gt; 企业“授权签”。使用文件发起“授权签”时使用前请联系对接的客户经理沟通。</p>
11773
11627
  :rtype: int
11774
11628
  """
11775
11629
  return self._ApproverType
@@ -11791,7 +11645,7 @@ class CommonFlowApprover(AbstractModel):
11791
11645
 
11792
11646
  @property
11793
11647
  def OrganizationOpenId(self):
11794
- r"""<p>企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传</p>
11648
+ r"""<p>企业OpenId,第三方应用集成非“授权签”子客企业签署人发起合同必传</p>
11795
11649
  :rtype: str
11796
11650
  """
11797
11651
  return self._OrganizationOpenId
@@ -11802,7 +11656,7 @@ class CommonFlowApprover(AbstractModel):
11802
11656
 
11803
11657
  @property
11804
11658
  def OrganizationName(self):
11805
- r"""<p>企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传</p>
11659
+ r"""<p>企业名称,第三方应用集成非“授权签”子客企业签署人必传,saas企业签署人必传</p>
11806
11660
  :rtype: str
11807
11661
  """
11808
11662
  return self._OrganizationName
@@ -12826,24 +12680,15 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
12826
12680
 
12827
12681
  def __init__(self):
12828
12682
  r"""
12829
- :param _Agent: 应用相关信息。 此接口Agent.AppId 必填。
12683
+ :param _Agent: <p>应用相关信息。 此接口Agent.AppId 必填。</p>
12830
12684
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
12831
- :param _OperateTypes: 初始化操作类型
12832
- <ul>
12833
- <li>CREATE_SEAL : 创建印章</li>
12834
- <li>OPEN_AUTO_SIGN :开通企业自动签署</li>
12835
- <li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签</li>
12836
- </ul>
12685
+ :param _OperateTypes: <p>初始化操作类型<ul><li>CREATE_SEAL : 创建印章</li><li>OPEN_AUTO_SIGN :开通企业授权签署</li><li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权“授权签”</li></ul></p>
12837
12686
  :type OperateTypes: list of str
12838
- :param _ProxyOrganizationOpenIds: 批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个
12687
+ :param _ProxyOrganizationOpenIds: <p>批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个</p>
12839
12688
  :type ProxyOrganizationOpenIds: list of str
12840
- :param _IsAuthorizePlatformApplication: 当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。
12841
- ![image](https://qcloudimg.tencent-cloud.cn/raw/f9aba7c999a6d79ada20b4384520e120.png)
12689
+ :param _IsAuthorizePlatformApplication: <p>当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权【授权签】时传true。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/f9aba7c999a6d79ada20b4384520e120.png" alt="image"></p>
12842
12690
  :type IsAuthorizePlatformApplication: bool
12843
- :param _AuthorizedProxyOrganizationOpenId: 被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。
12844
-
12845
-
12846
-
12691
+ :param _AuthorizedProxyOrganizationOpenId: <p>被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权【授权签】时必传。</p>
12847
12692
  :type AuthorizedProxyOrganizationOpenId: str
12848
12693
  """
12849
12694
  self._Agent = None
@@ -12854,7 +12699,7 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
12854
12699
 
12855
12700
  @property
12856
12701
  def Agent(self):
12857
- r"""应用相关信息。 此接口Agent.AppId 必填。
12702
+ r"""<p>应用相关信息。 此接口Agent.AppId 必填。</p>
12858
12703
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
12859
12704
  """
12860
12705
  return self._Agent
@@ -12865,12 +12710,7 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
12865
12710
 
12866
12711
  @property
12867
12712
  def OperateTypes(self):
12868
- r"""初始化操作类型
12869
- <ul>
12870
- <li>CREATE_SEAL : 创建印章</li>
12871
- <li>OPEN_AUTO_SIGN :开通企业自动签署</li>
12872
- <li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权自动签</li>
12873
- </ul>
12713
+ r"""<p>初始化操作类型<ul><li>CREATE_SEAL : 创建印章</li><li>OPEN_AUTO_SIGN :开通企业授权签署</li><li>PARTNER_AUTO_SIGN_AUTH :合作方企业或应用平台方授权“授权签”</li></ul></p>
12874
12714
  :rtype: list of str
12875
12715
  """
12876
12716
  return self._OperateTypes
@@ -12881,7 +12721,7 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
12881
12721
 
12882
12722
  @property
12883
12723
  def ProxyOrganizationOpenIds(self):
12884
- r"""批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个
12724
+ r"""<p>批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个</p>
12885
12725
  :rtype: list of str
12886
12726
  """
12887
12727
  return self._ProxyOrganizationOpenIds
@@ -12892,8 +12732,7 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
12892
12732
 
12893
12733
  @property
12894
12734
  def IsAuthorizePlatformApplication(self):
12895
- r"""当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权自动签时传true。
12896
- ![image](https://qcloudimg.tencent-cloud.cn/raw/f9aba7c999a6d79ada20b4384520e120.png)
12735
+ r"""<p>当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且是给应用平台方授权【授权签】时传true。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/f9aba7c999a6d79ada20b4384520e120.png" alt="image"></p>
12897
12736
  :rtype: bool
12898
12737
  """
12899
12738
  return self._IsAuthorizePlatformApplication
@@ -12904,10 +12743,7 @@ class CreateBatchInitOrganizationUrlRequest(AbstractModel):
12904
12743
 
12905
12744
  @property
12906
12745
  def AuthorizedProxyOrganizationOpenId(self):
12907
- r"""被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权自动签时必传。
12908
-
12909
-
12910
-
12746
+ r"""<p>被授权的合作方企业在第三方平台子客企业标识,即ProxyOrganizationOpenId,当操作类型包含 PARTNER_AUTO_SIGN_AUTH 且要进行合作方企业授权【授权签】时必传。</p>
12911
12747
  :rtype: str
12912
12748
  """
12913
12749
  return self._AuthorizedProxyOrganizationOpenId
@@ -12942,13 +12778,13 @@ class CreateBatchInitOrganizationUrlResponse(AbstractModel):
12942
12778
 
12943
12779
  def __init__(self):
12944
12780
  r"""
12945
- :param _MiniAppPath: 小程序路径,有效时间为7天
12781
+ :param _MiniAppPath: <p>小程序路径,有效时间为7天</p>
12946
12782
  :type MiniAppPath: str
12947
- :param _OperateLongUrl: 操作长链,有效时间为7天
12783
+ :param _OperateLongUrl: <p>操作长链,有效时间为7天</p>
12948
12784
  :type OperateLongUrl: str
12949
- :param _OperateShortUrl: 操作短链,有效时间为7天
12785
+ :param _OperateShortUrl: <p>操作短链,有效时间为7天</p>
12950
12786
  :type OperateShortUrl: str
12951
- :param _QRCodeUrl: 操作二维码,有效时间为7天
12787
+ :param _QRCodeUrl: <p>操作二维码,有效时间为7天</p>
12952
12788
  :type QRCodeUrl: str
12953
12789
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12954
12790
  :type RequestId: str
@@ -12961,7 +12797,7 @@ class CreateBatchInitOrganizationUrlResponse(AbstractModel):
12961
12797
 
12962
12798
  @property
12963
12799
  def MiniAppPath(self):
12964
- r"""小程序路径,有效时间为7天
12800
+ r"""<p>小程序路径,有效时间为7天</p>
12965
12801
  :rtype: str
12966
12802
  """
12967
12803
  return self._MiniAppPath
@@ -12972,7 +12808,7 @@ class CreateBatchInitOrganizationUrlResponse(AbstractModel):
12972
12808
 
12973
12809
  @property
12974
12810
  def OperateLongUrl(self):
12975
- r"""操作长链,有效时间为7天
12811
+ r"""<p>操作长链,有效时间为7天</p>
12976
12812
  :rtype: str
12977
12813
  """
12978
12814
  return self._OperateLongUrl
@@ -12983,7 +12819,7 @@ class CreateBatchInitOrganizationUrlResponse(AbstractModel):
12983
12819
 
12984
12820
  @property
12985
12821
  def OperateShortUrl(self):
12986
- r"""操作短链,有效时间为7天
12822
+ r"""<p>操作短链,有效时间为7天</p>
12987
12823
  :rtype: str
12988
12824
  """
12989
12825
  return self._OperateShortUrl
@@ -12994,7 +12830,7 @@ class CreateBatchInitOrganizationUrlResponse(AbstractModel):
12994
12830
 
12995
12831
  @property
12996
12832
  def QRCodeUrl(self):
12997
- r"""操作二维码,有效时间为7天
12833
+ r"""<p>操作二维码,有效时间为7天</p>
12998
12834
  :rtype: str
12999
12835
  """
13000
12836
  return self._QRCodeUrl
@@ -14019,7 +13855,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
14019
13855
  r"""
14020
13856
  :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容<br>此接口下面信息必填。</p><ul><li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>注:<code>1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识,建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。</code><code>2. 员工认证时, 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识,建议开发者保存此员工的OpenId,后续各项接口调用皆需要此参数。</code><code>3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一,员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。</code>
14021
13857
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
14022
- :param _ProxyOrganizationName: <p>第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。<br><font color="red"><br>在测试环境联调的过程中,企业名称请统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。<br>企业名称请使用以下名称, 以下名称可以不用走收录。<br><strong>子客测试专用企业1 - 子客测试专用企业9</strong></font></p><p>注:<br> <code>1. 如果名称中包含英文括号(),请使用中文括号()代替。</code><br> <code>2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。</code></p>
13858
+ :param _ProxyOrganizationName: <p>第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。<br><font color="red"><br>在测试环境联调的过程中,企业名称请再最后统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。<br></font></p><p>注:<br> <code>1. 如果名称中包含英文括号(),请使用中文括号()代替。</code><br> <code>2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。</code></p>
14023
13859
  :type ProxyOrganizationName: str
14024
13860
  :param _UniformSocialCreditCode: <p>子客企业统一社会信用代码,最大长度200个字符<br>注意:<code>如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效</code>。</p>
14025
13861
  :type UniformSocialCreditCode: str
@@ -14107,7 +13943,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
14107
13943
 
14108
13944
  @property
14109
13945
  def ProxyOrganizationName(self):
14110
- r"""<p>第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。<br><font color="red"><br>在测试环境联调的过程中,企业名称请统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。<br>企业名称请使用以下名称, 以下名称可以不用走收录。<br><strong>子客测试专用企业1 - 子客测试专用企业9</strong></font></p><p>注:<br> <code>1. 如果名称中包含英文括号(),请使用中文括号()代替。</code><br> <code>2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。</code></p>
13946
+ r"""<p>第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。<br><font color="red"><br>在测试环境联调的过程中,企业名称请再最后统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。<br></font></p><p>注:<br> <code>1. 如果名称中包含英文括号(),请使用中文括号()代替。</code><br> <code>2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。</code></p>
14111
13947
  :rtype: str
14112
13948
  """
14113
13949
  return self._ProxyOrganizationName
@@ -15359,7 +15195,7 @@ class CreateFlowOption(AbstractModel):
15359
15195
  :type HideShowDeadline: bool
15360
15196
  :param _CanSkipAddApprover: <p>是否允许发起合同步骤跳过指定签署方步骤<br><strong>true</strong>:允许<br><strong>false</strong>:(默认)不允许</p>
15361
15197
  :type CanSkipAddApprover: bool
15362
- :param _ForbidEditApprover: <p>是否可以编辑签署人包括新增,修改,删除 </p><ul><li>(默认) false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul><p>注意:</p><ul><li>如果设置参数为 true, 则 参数签署人 <a href="https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow">FlowApproverList</a> 不能为空</li><li>此参数对子客和自动签无效,不允许进行修改。</li></ul>
15198
+ :param _ForbidEditApprover: <p>是否可以编辑签署人包括新增,修改,删除 <ul><li>(默认) false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul>注意:* 如果设置参数为 true, 则 参数签署人 <a href="https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow">FlowApproverList</a> 不能为空* 此参数对子客和“授权签”无效,不允许进行修改。</p>
15363
15199
  :type ForbidEditApprover: bool
15364
15200
  :param _CustomCreateFlowDescription: <p>定制化发起合同弹窗的描述信息,长度不能超过500,只能由中文、字母、数字和标点组成。</p>
15365
15201
  :type CustomCreateFlowDescription: str
@@ -15477,7 +15313,7 @@ class CreateFlowOption(AbstractModel):
15477
15313
 
15478
15314
  @property
15479
15315
  def ForbidEditApprover(self):
15480
- r"""<p>是否可以编辑签署人包括新增,修改,删除 </p><ul><li>(默认) false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul><p>注意:</p><ul><li>如果设置参数为 true, 则 参数签署人 <a href="https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow">FlowApproverList</a> 不能为空</li><li>此参数对子客和自动签无效,不允许进行修改。</li></ul>
15316
+ r"""<p>是否可以编辑签署人包括新增,修改,删除 <ul><li>(默认) false -可以编辑签署人</li> <li> true - 禁止编辑签署人</li></ul>注意:* 如果设置参数为 true, 则 参数签署人 <a href="https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow">FlowApproverList</a> 不能为空* 此参数对子客和“授权签”无效,不允许进行修改。</p>
15481
15317
  :rtype: bool
15482
15318
  """
15483
15319
  return self._ForbidEditApprover
@@ -16598,15 +16434,15 @@ class CreatePersonAuthCertificateImageRequest(AbstractModel):
16598
16434
 
16599
16435
  def __init__(self):
16600
16436
  r"""
16601
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
16437
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
16602
16438
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
16603
- :param _UserName: 个人用户名称
16439
+ :param _UserName: <p>个人用户名称</p>
16604
16440
  :type UserName: str
16605
- :param _IdCardType: 证件类型,支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
16441
+ :param _IdCardType: <p>证件类型,支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul></p>
16606
16442
  :type IdCardType: str
16607
- :param _IdCardNumber: 证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
16443
+ :param _IdCardNumber: <p>证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul></p>
16608
16444
  :type IdCardNumber: str
16609
- :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>注: `不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN`
16445
+ :param _SceneKey: <p>授权使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul><p>默认值:E_PRESCRIPTION_AUTO_SIGN</p><p>注: <code>不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN</code></p>
16610
16446
  :type SceneKey: str
16611
16447
  """
16612
16448
  self._Agent = None
@@ -16617,7 +16453,7 @@ class CreatePersonAuthCertificateImageRequest(AbstractModel):
16617
16453
 
16618
16454
  @property
16619
16455
  def Agent(self):
16620
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
16456
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p>
16621
16457
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
16622
16458
  """
16623
16459
  return self._Agent
@@ -16628,7 +16464,7 @@ class CreatePersonAuthCertificateImageRequest(AbstractModel):
16628
16464
 
16629
16465
  @property
16630
16466
  def UserName(self):
16631
- r"""个人用户名称
16467
+ r"""<p>个人用户名称</p>
16632
16468
  :rtype: str
16633
16469
  """
16634
16470
  return self._UserName
@@ -16639,7 +16475,7 @@ class CreatePersonAuthCertificateImageRequest(AbstractModel):
16639
16475
 
16640
16476
  @property
16641
16477
  def IdCardType(self):
16642
- r"""证件类型,支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
16478
+ r"""<p>证件类型,支持以下类型<ul><li> ID_CARD : 中国大陆居民身份证 (默认值)</li><li> HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li> HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul></p>
16643
16479
  :rtype: str
16644
16480
  """
16645
16481
  return self._IdCardType
@@ -16650,7 +16486,7 @@ class CreatePersonAuthCertificateImageRequest(AbstractModel):
16650
16486
 
16651
16487
  @property
16652
16488
  def IdCardNumber(self):
16653
- r"""证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
16489
+ r"""<p>证件号码,应符合以下规则<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul></p>
16654
16490
  :rtype: str
16655
16491
  """
16656
16492
  return self._IdCardNumber
@@ -16661,7 +16497,7 @@ class CreatePersonAuthCertificateImageRequest(AbstractModel):
16661
16497
 
16662
16498
  @property
16663
16499
  def SceneKey(self):
16664
- r"""自动签使用的场景值, 可以选择的场景值如下:<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>注: `不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN`
16500
+ r"""<p>授权使用的场景值, 可以选择的场景值如下:</p><p>枚举值:</p><ul><li>E_PRESCRIPTION_AUTO_SIGN: 电子处方场景</li><li>OTHER: 通用场景</li></ul><p>默认值:E_PRESCRIPTION_AUTO_SIGN</p><p>注: <code>不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN</code></p>
16665
16501
  :rtype: str
16666
16502
  """
16667
16503
  return self._SceneKey
@@ -16696,15 +16532,15 @@ class CreatePersonAuthCertificateImageResponse(AbstractModel):
16696
16532
 
16697
16533
  def __init__(self):
16698
16534
  r"""
16699
- :param _AuthCertUrl: 个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。
16535
+ :param _AuthCertUrl: <p>个人用户认证证书图片下载URL,<code>有效期为5分钟</code>,超过有效期后将无法再下载。</p>
16700
16536
  :type AuthCertUrl: str
16701
- :param _ImageCertId: 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
16537
+ :param _ImageCertId: <p>个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: <code>个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动</code></p>
16702
16538
  :type ImageCertId: str
16703
- :param _SerialNumber: 在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。
16539
+ :param _SerialNumber: <p>在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。</p>
16704
16540
  :type SerialNumber: str
16705
- :param _ValidFrom: CA证书颁发时间,格式为Unix标准时间戳(秒) 该时间格式化后会合成到个人用户证书证明图片
16541
+ :param _ValidFrom: <p>CA证书颁发时间,格式为Unix标准时间戳(秒) 该时间格式化后会合成到个人用户证书证明图片</p>
16706
16542
  :type ValidFrom: int
16707
- :param _ValidTo: CA证书有效截止时间,格式为Unix标准时间戳(秒)该时间格式化后会合成到个人用户证书证明图片
16543
+ :param _ValidTo: <p>CA证书有效截止时间,格式为Unix标准时间戳(秒)该时间格式化后会合成到个人用户证书证明图片</p>
16708
16544
  :type ValidTo: int
16709
16545
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
16710
16546
  :type RequestId: str
@@ -16718,7 +16554,7 @@ class CreatePersonAuthCertificateImageResponse(AbstractModel):
16718
16554
 
16719
16555
  @property
16720
16556
  def AuthCertUrl(self):
16721
- r"""个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。
16557
+ r"""<p>个人用户认证证书图片下载URL,<code>有效期为5分钟</code>,超过有效期后将无法再下载。</p>
16722
16558
  :rtype: str
16723
16559
  """
16724
16560
  return self._AuthCertUrl
@@ -16729,7 +16565,7 @@ class CreatePersonAuthCertificateImageResponse(AbstractModel):
16729
16565
 
16730
16566
  @property
16731
16567
  def ImageCertId(self):
16732
- r"""个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
16568
+ r"""<p>个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。该编号会合成到个人用户证书证明图片。注: <code>个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动</code></p>
16733
16569
  :rtype: str
16734
16570
  """
16735
16571
  return self._ImageCertId
@@ -16740,7 +16576,7 @@ class CreatePersonAuthCertificateImageResponse(AbstractModel):
16740
16576
 
16741
16577
  @property
16742
16578
  def SerialNumber(self):
16743
- r"""在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。
16579
+ r"""<p>在数字证书申请过程中,系统会自动生成一个独一无二的序列号。请注意,当证书到期并自动续期时,该序列号将会发生变化。值得注意的是,此序列号不会被合成至个人用户证书的证明图片中。</p>
16744
16580
  :rtype: str
16745
16581
  """
16746
16582
  return self._SerialNumber
@@ -16751,7 +16587,7 @@ class CreatePersonAuthCertificateImageResponse(AbstractModel):
16751
16587
 
16752
16588
  @property
16753
16589
  def ValidFrom(self):
16754
- r"""CA证书颁发时间,格式为Unix标准时间戳(秒) 该时间格式化后会合成到个人用户证书证明图片
16590
+ r"""<p>CA证书颁发时间,格式为Unix标准时间戳(秒) 该时间格式化后会合成到个人用户证书证明图片</p>
16755
16591
  :rtype: int
16756
16592
  """
16757
16593
  return self._ValidFrom
@@ -16762,7 +16598,7 @@ class CreatePersonAuthCertificateImageResponse(AbstractModel):
16762
16598
 
16763
16599
  @property
16764
16600
  def ValidTo(self):
16765
- r"""CA证书有效截止时间,格式为Unix标准时间戳(秒)该时间格式化后会合成到个人用户证书证明图片
16601
+ r"""<p>CA证书有效截止时间,格式为Unix标准时间戳(秒)该时间格式化后会合成到个人用户证书证明图片</p>
16766
16602
  :rtype: int
16767
16603
  """
16768
16604
  return self._ValidTo
@@ -18925,26 +18761,13 @@ class DescribeExtendedServiceAuthDetailRequest(AbstractModel):
18925
18761
 
18926
18762
  def __init__(self):
18927
18763
  r"""
18928
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
18929
-
18930
- 此接口下面信息必填。
18931
- <ul>
18932
- <li>渠道应用标识: Agent.AppId</li>
18933
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
18934
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
18935
- </ul>
18936
- 第三方平台子客企业和员工必须已经经过实名认证
18764
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
18937
18765
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
18938
- :param _ExtendServiceType: 要查询的扩展服务类型。
18939
- 如下所示:
18940
- <ul><li> AUTO_SIGN:企业静默签署</li>
18941
- <li>BATCH_SIGN:批量签署</li>
18942
- </ul>
18943
-
18766
+ :param _ExtendServiceType: <p>要查询的扩展服务类型。<br>如下所示:</p><p>枚举值:</p><ul><li>AUTO_SIGN: 企业授权签署</li><li>BATCH_SIGN: 批量签署</li></ul>
18944
18767
  :type ExtendServiceType: str
18945
- :param _Limit: 指定每页返回的数据条数,和Offset参数配合使用。 注:`1.默认值为20,单页做大值为200。`
18768
+ :param _Limit: <p>指定每页返回的数据条数,和Offset参数配合使用。 注:<code>1.默认值为20,单页做大值为200。</code></p>
18946
18769
  :type Limit: int
18947
- :param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:`1.offset从0开始,即第一页为0。` `2.默认从第一页返回。`
18770
+ :param _Offset: <p>查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:<code>1.offset从0开始,即第一页为0。</code> <code>2.默认从第一页返回。</code></p>
18948
18771
  :type Offset: int
18949
18772
  """
18950
18773
  self._Agent = None
@@ -18954,15 +18777,7 @@ class DescribeExtendedServiceAuthDetailRequest(AbstractModel):
18954
18777
 
18955
18778
  @property
18956
18779
  def Agent(self):
18957
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
18958
-
18959
- 此接口下面信息必填。
18960
- <ul>
18961
- <li>渠道应用标识: Agent.AppId</li>
18962
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
18963
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
18964
- </ul>
18965
- 第三方平台子客企业和员工必须已经经过实名认证
18780
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
18966
18781
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
18967
18782
  """
18968
18783
  return self._Agent
@@ -18973,12 +18788,7 @@ class DescribeExtendedServiceAuthDetailRequest(AbstractModel):
18973
18788
 
18974
18789
  @property
18975
18790
  def ExtendServiceType(self):
18976
- r"""要查询的扩展服务类型。
18977
- 如下所示:
18978
- <ul><li> AUTO_SIGN:企业静默签署</li>
18979
- <li>BATCH_SIGN:批量签署</li>
18980
- </ul>
18981
-
18791
+ r"""<p>要查询的扩展服务类型。<br>如下所示:</p><p>枚举值:</p><ul><li>AUTO_SIGN: 企业授权签署</li><li>BATCH_SIGN: 批量签署</li></ul>
18982
18792
  :rtype: str
18983
18793
  """
18984
18794
  return self._ExtendServiceType
@@ -18989,7 +18799,7 @@ class DescribeExtendedServiceAuthDetailRequest(AbstractModel):
18989
18799
 
18990
18800
  @property
18991
18801
  def Limit(self):
18992
- r"""指定每页返回的数据条数,和Offset参数配合使用。 注:`1.默认值为20,单页做大值为200。`
18802
+ r"""<p>指定每页返回的数据条数,和Offset参数配合使用。 注:<code>1.默认值为20,单页做大值为200。</code></p>
18993
18803
  :rtype: int
18994
18804
  """
18995
18805
  return self._Limit
@@ -19000,7 +18810,7 @@ class DescribeExtendedServiceAuthDetailRequest(AbstractModel):
19000
18810
 
19001
18811
  @property
19002
18812
  def Offset(self):
19003
- r"""查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:`1.offset从0开始,即第一页为0。` `2.默认从第一页返回。`
18813
+ r"""<p>查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:<code>1.offset从0开始,即第一页为0。</code> <code>2.默认从第一页返回。</code></p>
19004
18814
  :rtype: int
19005
18815
  """
19006
18816
  return self._Offset
@@ -19034,7 +18844,7 @@ class DescribeExtendedServiceAuthDetailResponse(AbstractModel):
19034
18844
 
19035
18845
  def __init__(self):
19036
18846
  r"""
19037
- :param _AuthInfoDetail: 服务授权的信息列表,根据查询类型返回特定扩展服务的开通和授权状况。
18847
+ :param _AuthInfoDetail: <p>服务授权的信息列表,根据查询类型返回特定扩展服务的开通和授权状况。</p>
19038
18848
  :type AuthInfoDetail: :class:`tencentcloud.essbasic.v20210526.models.AuthInfoDetail`
19039
18849
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
19040
18850
  :type RequestId: str
@@ -19044,7 +18854,7 @@ class DescribeExtendedServiceAuthDetailResponse(AbstractModel):
19044
18854
 
19045
18855
  @property
19046
18856
  def AuthInfoDetail(self):
19047
- r"""服务授权的信息列表,根据查询类型返回特定扩展服务的开通和授权状况。
18857
+ r"""<p>服务授权的信息列表,根据查询类型返回特定扩展服务的开通和授权状况。</p>
19048
18858
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.AuthInfoDetail`
19049
18859
  """
19050
18860
  return self._AuthInfoDetail
@@ -19079,30 +18889,14 @@ class DescribeExtendedServiceAuthInfoRequest(AbstractModel):
19079
18889
 
19080
18890
  def __init__(self):
19081
18891
  r"""
19082
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
19083
-
19084
- 此接口下面信息必填。
19085
- <ul>
19086
- <li>渠道应用标识: Agent.AppId</li>
19087
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
19088
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
19089
- </ul>
19090
- 第三方平台子客企业和员工必须已经过实名认证
18892
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
19091
18893
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
19092
18894
  """
19093
18895
  self._Agent = None
19094
18896
 
19095
18897
  @property
19096
18898
  def Agent(self):
19097
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
19098
-
19099
- 此接口下面信息必填。
19100
- <ul>
19101
- <li>渠道应用标识: Agent.AppId</li>
19102
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
19103
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
19104
- </ul>
19105
- 第三方平台子客企业和员工必须已经过实名认证
18899
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
19106
18900
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
19107
18901
  """
19108
18902
  return self._Agent
@@ -19133,7 +18927,7 @@ class DescribeExtendedServiceAuthInfoResponse(AbstractModel):
19133
18927
 
19134
18928
  def __init__(self):
19135
18929
  r"""
19136
- :param _AuthInfo: 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
18930
+ :param _AuthInfo: <p>服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。</p>
19137
18931
  :type AuthInfo: list of ExtentServiceAuthInfo
19138
18932
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
19139
18933
  :type RequestId: str
@@ -19143,7 +18937,7 @@ class DescribeExtendedServiceAuthInfoResponse(AbstractModel):
19143
18937
 
19144
18938
  @property
19145
18939
  def AuthInfo(self):
19146
- r"""服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
18940
+ r"""<p>服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。</p>
19147
18941
  :rtype: list of ExtentServiceAuthInfo
19148
18942
  """
19149
18943
  return self._AuthInfo
@@ -20537,16 +20331,13 @@ class DynamicFlowInfo(AbstractModel):
20537
20331
 
20538
20332
  def __init__(self):
20539
20333
  r"""
20540
- :param _FlowId: 合同流程ID,为32位字符串。
20541
- - FlowId 在通过[ChannelCreateFlowByFiles](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles) 发起,可以在返回参数FlowId中获取。
20542
- - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
20543
- - 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
20334
+ :param _FlowId: <p>合同流程ID,为32位字符串。 </p><ul><li>FlowId 在通过<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles">ChannelCreateFlowByFiles</a> 发起,可以在返回参数FlowId中获取。</li><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 </li><li>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
20544
20335
  :type FlowId: str
20545
- :param _FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
20336
+ :param _FlowApprovers: <p>合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a>。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。</p>
20546
20337
  :type FlowApprovers: list of FlowApproverInfo
20547
- :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传: <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
20338
+ :param _AutoSignScene: <p>个人“授权签”名的使用场景包括以下, 个人“授权签”(即ApproverType设置成个人“授权签”时)业务此值必传: <ul><li> <strong>E_PRESCRIPTION_AUTO_SIGN</strong>:电子处方单(医疗“授权签”) </li><li> <strong>OTHER</strong> : 通用场景</li></ul> 注: <code>个人“授权签”名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code></p>
20548
20339
  :type AutoSignScene: str
20549
- :param _ApproverVerifyType: 签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
20340
+ :param _ApproverVerifyType: <p>签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。</p>
20550
20341
  :type ApproverVerifyType: str
20551
20342
  """
20552
20343
  self._FlowId = None
@@ -20556,10 +20347,7 @@ class DynamicFlowInfo(AbstractModel):
20556
20347
 
20557
20348
  @property
20558
20349
  def FlowId(self):
20559
- r"""合同流程ID,为32位字符串。
20560
- - FlowId 在通过[ChannelCreateFlowByFiles](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles) 发起,可以在返回参数FlowId中获取。
20561
- - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
20562
- - 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
20350
+ r"""<p>合同流程ID,为32位字符串。 </p><ul><li>FlowId 在通过<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles">ChannelCreateFlowByFiles</a> 发起,可以在返回参数FlowId中获取。</li><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 </li><li>可登录腾讯电子签控制台,在 &quot;合同&quot;-&gt;&quot;合同中心&quot; 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
20563
20351
  :rtype: str
20564
20352
  """
20565
20353
  return self._FlowId
@@ -20570,7 +20358,7 @@ class DynamicFlowInfo(AbstractModel):
20570
20358
 
20571
20359
  @property
20572
20360
  def FlowApprovers(self):
20573
- r"""合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
20361
+ r"""<p>合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 <a href="https://qian.tencent.com/developers/partner/flow_approver">签署方入参指引</a>。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。</p>
20574
20362
  :rtype: list of FlowApproverInfo
20575
20363
  """
20576
20364
  return self._FlowApprovers
@@ -20581,7 +20369,7 @@ class DynamicFlowInfo(AbstractModel):
20581
20369
 
20582
20370
  @property
20583
20371
  def AutoSignScene(self):
20584
- r"""个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传: <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
20372
+ r"""<p>个人“授权签”名的使用场景包括以下, 个人“授权签”(即ApproverType设置成个人“授权签”时)业务此值必传: <ul><li> <strong>E_PRESCRIPTION_AUTO_SIGN</strong>:电子处方单(医疗“授权签”) </li><li> <strong>OTHER</strong> : 通用场景</li></ul> 注: <code>个人“授权签”名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code></p>
20585
20373
  :rtype: str
20586
20374
  """
20587
20375
  return self._AutoSignScene
@@ -20592,7 +20380,7 @@ class DynamicFlowInfo(AbstractModel):
20592
20380
 
20593
20381
  @property
20594
20382
  def ApproverVerifyType(self):
20595
- r"""签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
20383
+ r"""<p>签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。</p>
20596
20384
  :rtype: str
20597
20385
  """
20598
20386
  return self._ApproverVerifyType
@@ -20902,25 +20690,15 @@ class ExtentServiceAuthInfo(AbstractModel):
20902
20690
 
20903
20691
  def __init__(self):
20904
20692
  r"""
20905
- :param _Type: 扩展服务类型
20906
- <ul>
20907
- <li>AUTO_SIGN 企业自动签(自动签署)</li>
20908
- <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
20909
- <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
20910
- <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
20911
- <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
20912
- <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
20913
- </ul>
20693
+ :param _Type: <p>扩展服务类型<ul><li>AUTO_SIGN 企业“授权签”(“授权签”)</li><li> OVERSEA_SIGN 企业与港澳台居民签署合同</li><li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li><li> DOWNLOAD_FLOW 授权渠道下载合同 </li><li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li><li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li></ul></p>
20914
20694
  :type Type: str
20915
- :param _Name: 扩展服务名称
20695
+ :param _Name: <p>扩展服务名称</p>
20916
20696
  :type Name: str
20917
- :param _Status: 扩展服务的开通状态
20918
- **ENABLE**:开通
20919
- **DISABLE**:未开通
20697
+ :param _Status: <p>扩展服务的开通状态<br><strong>ENABLE</strong>:开通<br><strong>DISABLE</strong>:未开通</p>
20920
20698
  :type Status: str
20921
- :param _OperatorOpenId: 操作扩展服务的操作人第三方应用平台的用户openid
20699
+ :param _OperatorOpenId: <p>操作扩展服务的操作人第三方应用平台的用户openid</p>
20922
20700
  :type OperatorOpenId: str
20923
- :param _OperateOn: 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
20701
+ :param _OperateOn: <p>扩展服务的操作时间,格式为Unix标准时间戳(秒)。</p>
20924
20702
  :type OperateOn: int
20925
20703
  """
20926
20704
  self._Type = None
@@ -20931,15 +20709,7 @@ class ExtentServiceAuthInfo(AbstractModel):
20931
20709
 
20932
20710
  @property
20933
20711
  def Type(self):
20934
- r"""扩展服务类型
20935
- <ul>
20936
- <li>AUTO_SIGN 企业自动签(自动签署)</li>
20937
- <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
20938
- <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
20939
- <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
20940
- <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
20941
- <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
20942
- </ul>
20712
+ r"""<p>扩展服务类型<ul><li>AUTO_SIGN 企业“授权签”(“授权签”)</li><li> OVERSEA_SIGN 企业与港澳台居民签署合同</li><li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li><li> DOWNLOAD_FLOW 授权渠道下载合同 </li><li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li><li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li></ul></p>
20943
20713
  :rtype: str
20944
20714
  """
20945
20715
  return self._Type
@@ -20950,7 +20720,7 @@ class ExtentServiceAuthInfo(AbstractModel):
20950
20720
 
20951
20721
  @property
20952
20722
  def Name(self):
20953
- r"""扩展服务名称
20723
+ r"""<p>扩展服务名称</p>
20954
20724
  :rtype: str
20955
20725
  """
20956
20726
  return self._Name
@@ -20961,9 +20731,7 @@ class ExtentServiceAuthInfo(AbstractModel):
20961
20731
 
20962
20732
  @property
20963
20733
  def Status(self):
20964
- r"""扩展服务的开通状态
20965
- **ENABLE**:开通
20966
- **DISABLE**:未开通
20734
+ r"""<p>扩展服务的开通状态<br><strong>ENABLE</strong>:开通<br><strong>DISABLE</strong>:未开通</p>
20967
20735
  :rtype: str
20968
20736
  """
20969
20737
  return self._Status
@@ -20974,7 +20742,7 @@ class ExtentServiceAuthInfo(AbstractModel):
20974
20742
 
20975
20743
  @property
20976
20744
  def OperatorOpenId(self):
20977
- r"""操作扩展服务的操作人第三方应用平台的用户openid
20745
+ r"""<p>操作扩展服务的操作人第三方应用平台的用户openid</p>
20978
20746
  :rtype: str
20979
20747
  """
20980
20748
  return self._OperatorOpenId
@@ -20985,7 +20753,7 @@ class ExtentServiceAuthInfo(AbstractModel):
20985
20753
 
20986
20754
  @property
20987
20755
  def OperateOn(self):
20988
- r"""扩展服务的操作时间,格式为Unix标准时间戳(秒)。
20756
+ r"""<p>扩展服务的操作时间,格式为Unix标准时间戳(秒)。</p>
20989
20757
  :rtype: int
20990
20758
  """
20991
20759
  return self._OperateOn
@@ -21756,7 +21524,7 @@ class FlowApproverInfo(AbstractModel):
21756
21524
  :type OpenId: str
21757
21525
  :param _OrganizationOpenId: <p>同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符</p>
21758
21526
  :type OrganizationOpenId: str
21759
- :param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:</p><ul><li> **PERSON** :个人/自然人</li><li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li><li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li><li> **ENTERPRISESERVER** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul><p>注:<br><code>1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。</code><br><code>2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:</code></p><ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li><li>条件2:子客之间完成授权</li><li>条件3:联系对接的客户经理沟通如何使用</li></ul>
21527
+ :param _ApproverType: <p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:<ul><li> <strong>PERSON</strong> :个人/自然人</li><li> <strong>PERSON_AUTO_SIGN</strong> :个人/自然人“授权签”,适用于个人“授权签”场景</li><li> <strong>ORGANIZATION</strong> :企业/企业员工(企业签署方或模板发起时的企业“授权签”)</li><li> <strong>ENTERPRISESERVER</strong> :企业/企业员工“授权签”(他方企业“授权签”或文件发起时的本方企业“授权签”)</li></ul>注: <code>1. 个人“授权签”场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。</code><code>2. 若要实现他方企业(同一应用下)“授权签”,需要满足3个条件:</code><ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li><li>条件2:子客之间完成授权</li><li>条件3:联系对接的客户经理沟通如何使用</li></ul></p>
21760
21528
  :type ApproverType: str
21761
21529
  :param _RecipientId: <p>签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;</p>
21762
21530
  :type RecipientId: str
@@ -21774,7 +21542,7 @@ class FlowApproverInfo(AbstractModel):
21774
21542
  :type JumpUrl: str
21775
21543
  :param _ApproverOption: <p>可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人、是否为动态补充签署人等。<br>详细操作可以参考开发者中心的ApproverOption结构体。</p>
21776
21544
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
21777
- :param _ApproverNeedSignReview: <p>此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:</p><ul><li>**false**:(默认)不需要审批,直接签署。</li><li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul><p>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
21545
+ :param _ApproverNeedSignReview: <p>此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:<ul><li><strong>false</strong>:(默认)不需要审批,直接签署。</li><li><strong>true</strong>:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、“授权签”合同</code><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
21778
21546
  :type ApproverNeedSignReview: bool
21779
21547
  :param _ApproverVerifyTypes: <p>指定个人签署方查看合同的校验方式,可以传值如下:</p><ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li><li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)</li></ul>注: <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li><li>此字段可传多个校验方式</li></ul>
21780
21548
  :type ApproverVerifyTypes: list of int
@@ -21919,7 +21687,7 @@ class FlowApproverInfo(AbstractModel):
21919
21687
 
21920
21688
  @property
21921
21689
  def ApproverType(self):
21922
- r"""<p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:</p><ul><li> **PERSON** :个人/自然人</li><li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li><li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li><li> **ENTERPRISESERVER** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul><p>注:<br><code>1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。</code><br><code>2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:</code></p><ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li><li>条件2:子客之间完成授权</li><li>条件3:联系对接的客户经理沟通如何使用</li></ul>
21690
+ r"""<p>在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:<ul><li> <strong>PERSON</strong> :个人/自然人</li><li> <strong>PERSON_AUTO_SIGN</strong> :个人/自然人“授权签”,适用于个人“授权签”场景</li><li> <strong>ORGANIZATION</strong> :企业/企业员工(企业签署方或模板发起时的企业“授权签”)</li><li> <strong>ENTERPRISESERVER</strong> :企业/企业员工“授权签”(他方企业“授权签”或文件发起时的本方企业“授权签”)</li></ul>注: <code>1. 个人“授权签”场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。</code><code>2. 若要实现他方企业(同一应用下)“授权签”,需要满足3个条件:</code><ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li><li>条件2:子客之间完成授权</li><li>条件3:联系对接的客户经理沟通如何使用</li></ul></p>
21923
21691
  :rtype: str
21924
21692
  """
21925
21693
  return self._ApproverType
@@ -22022,7 +21790,7 @@ class FlowApproverInfo(AbstractModel):
22022
21790
 
22023
21791
  @property
22024
21792
  def ApproverNeedSignReview(self):
22025
- r"""<p>此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:</p><ul><li>**false**:(默认)不需要审批,直接签署。</li><li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul><p>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、静默签署合同</code></p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
21793
+ r"""<p>此签署人(员工或者个人)签署前,是否需要发起方企业进行审批,取值如下:<ul><li><strong>false</strong>:(默认)不需要审批,直接签署。</li><li><strong>true</strong>:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待发起方企业内部审批完成。</li></ul>企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与发起方企业内部的审批流程进行关联,支持手动、“授权签”合同</code><img src="https://qcloudimg.tencent-cloud.cn/raw/b14d5188ed0229d1401e74a9a49cab6d.png" alt="image"></p>
22026
21794
  :rtype: bool
22027
21795
  """
22028
21796
  return self._ApproverNeedSignReview
@@ -23420,11 +23188,11 @@ class FlowInfo(AbstractModel):
23420
23188
  :type CustomShowMap: str
23421
23189
  :param _CcInfos: <p>合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。</p><p><b>注</b></p><ol><li>抄送人名单中可以包括自然人以及本企业的员工(本企业员工必须已经完成认证并加入企业)。</li><li>请确保抄送人列表中的成员不与任何签署人重复。</li></ol>
23422
23190
  :type CcInfos: list of CcInfo
23423
- :param _NeedSignReview: <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
23191
+ :param _NeedSignReview: <p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:<ul><li> <strong>false</strong>:(默认)不需要审批,直接签署。</li><li> <strong>true</strong>:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、“授权签”合同</code></p>
23424
23192
  :type NeedSignReview: bool
23425
23193
  :param _CcNotifyType: <p>若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:</p><ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li><li> **1** : 签署完成后通知对方来查看合同</li></ul>
23426
23194
  :type CcNotifyType: int
23427
- :param _AutoSignScene: <p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
23195
+ :param _AutoSignScene: <p>个人“授权签”名的使用场景包括以下, 个人“授权签”(即ApproverType设置成个人“授权签”时)业务此值必传:<ul><li> <strong>E_PRESCRIPTION_AUTO_SIGN</strong>:电子处方单(医疗“授权签”) </li><li> <strong>OTHER</strong> : 通用场景</li></ul>注: <code>个人“授权签”名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code></p>
23428
23196
  :type AutoSignScene: str
23429
23197
  :param _FlowDisplayType: <p>在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:<img src="https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png" alt="FlowDisplayType"></p>
23430
23198
  :type FlowDisplayType: int
@@ -23575,7 +23343,7 @@ class FlowInfo(AbstractModel):
23575
23343
 
23576
23344
  @property
23577
23345
  def NeedSignReview(self):
23578
- r"""<p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:</p><ul><li> **false**:(默认)不需要审批,直接签署。</li><li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同</code>
23346
+ r"""<p>发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:<ul><li> <strong>false</strong>:(默认)不需要审批,直接签署。</li><li> <strong>true</strong>:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li><li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>注:<code>此功能可用于与企业内部的审批流程进行关联,支持手动、“授权签”合同</code></p>
23579
23347
  :rtype: bool
23580
23348
  """
23581
23349
  return self._NeedSignReview
@@ -23597,7 +23365,7 @@ class FlowInfo(AbstractModel):
23597
23365
 
23598
23366
  @property
23599
23367
  def AutoSignScene(self):
23600
- r"""<p>个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:</p><ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>注: <code>个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code>
23368
+ r"""<p>个人“授权签”名的使用场景包括以下, 个人“授权签”(即ApproverType设置成个人“授权签”时)业务此值必传:<ul><li> <strong>E_PRESCRIPTION_AUTO_SIGN</strong>:电子处方单(医疗“授权签”) </li><li> <strong>OTHER</strong> : 通用场景</li></ul>注: <code>个人“授权签”名场景是白名单功能,使用前请与对接的客户经理联系沟通。</code></p>
23601
23369
  :rtype: str
23602
23370
  """
23603
23371
  return self._AutoSignScene
@@ -25080,38 +24848,13 @@ class ModifyExtendedServiceRequest(AbstractModel):
25080
24848
 
25081
24849
  def __init__(self):
25082
24850
  r"""
25083
- :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
25084
-
25085
- 此接口下面信息必填。
25086
- <ul>
25087
- <li>渠道应用标识: Agent.AppId</li>
25088
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
25089
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
25090
- </ul>
25091
- 第三方平台子客企业和员工必须已经过实名认证
24851
+ :param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
25092
24852
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
25093
- :param _ServiceType: 扩展服务类型
25094
- <ul>
25095
- <li>AUTO_SIGN 企业自动签(自动签署)</li>
25096
- <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
25097
- <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
25098
- <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
25099
- <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
25100
- <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
25101
- </ul>
24853
+ :param _ServiceType: <p>扩展服务类型</p><p>枚举值:</p><ul><li>AUTO_SIGN: 企业授权签</li><li>OVERSEA_SIGN: 企业与港澳台居民签署合同</li><li>MOBILE_CHECK_APPROVER: 使用手机号验证签署方身份</li><li>DOWNLOAD_FLOW: 授权渠道下载合同</li><li>AGE_LIMIT_EXPANSION: 拓宽签署方年龄限制</li><li>HIDE_OPERATOR_DISPLAY: 隐藏合同经办人姓名</li></ul>
25102
24854
  :type ServiceType: str
25103
- :param _Operate: 操作类型
25104
- <ul>
25105
- <li>OPEN : 开通</li>
25106
- <li>CLOSE : 关闭</li>
25107
- </ul>
24855
+ :param _Operate: <p>操作类型</p><ul><li>OPEN : 开通</li><li>CLOSE : 关闭</li></ul>
25108
24856
  :type Operate: str
25109
- :param _Endpoint: 链接跳转类型,支持以下类型
25110
- <ul>
25111
- <li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
25112
- <li>APP : 第三方APP或小程序跳转电子签小程序</li>
25113
- <li>WEIXIN_QRCODE_URL:直接跳转至电子签小程序的二维码链接,无需通过中转页。<font color="red">您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。</font></li>
25114
- </ul>
24857
+ :param _Endpoint: <p>链接跳转类型,支持以下类型</p><ul><li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li><li>APP : 第三方APP或小程序跳转电子签小程序</li><li>WEIXIN_QRCODE_URL:直接跳转至电子签小程序的二维码链接,无需通过中转页。<font color="red">您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。</font></li></ul>
25115
24858
  :type Endpoint: str
25116
24859
  """
25117
24860
  self._Agent = None
@@ -25121,15 +24864,7 @@ class ModifyExtendedServiceRequest(AbstractModel):
25121
24864
 
25122
24865
  @property
25123
24866
  def Agent(self):
25124
- r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
25125
-
25126
- 此接口下面信息必填。
25127
- <ul>
25128
- <li>渠道应用标识: Agent.AppId</li>
25129
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
25130
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
25131
- </ul>
25132
- 第三方平台子客企业和员工必须已经过实名认证
24867
+ r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经过实名认证
25133
24868
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
25134
24869
  """
25135
24870
  return self._Agent
@@ -25140,15 +24875,7 @@ class ModifyExtendedServiceRequest(AbstractModel):
25140
24875
 
25141
24876
  @property
25142
24877
  def ServiceType(self):
25143
- r""" 扩展服务类型
25144
- <ul>
25145
- <li>AUTO_SIGN 企业自动签(自动签署)</li>
25146
- <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
25147
- <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
25148
- <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
25149
- <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
25150
- <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
25151
- </ul>
24878
+ r"""<p>扩展服务类型</p><p>枚举值:</p><ul><li>AUTO_SIGN: 企业授权签</li><li>OVERSEA_SIGN: 企业与港澳台居民签署合同</li><li>MOBILE_CHECK_APPROVER: 使用手机号验证签署方身份</li><li>DOWNLOAD_FLOW: 授权渠道下载合同</li><li>AGE_LIMIT_EXPANSION: 拓宽签署方年龄限制</li><li>HIDE_OPERATOR_DISPLAY: 隐藏合同经办人姓名</li></ul>
25152
24879
  :rtype: str
25153
24880
  """
25154
24881
  return self._ServiceType
@@ -25159,11 +24886,7 @@ class ModifyExtendedServiceRequest(AbstractModel):
25159
24886
 
25160
24887
  @property
25161
24888
  def Operate(self):
25162
- r"""操作类型
25163
- <ul>
25164
- <li>OPEN : 开通</li>
25165
- <li>CLOSE : 关闭</li>
25166
- </ul>
24889
+ r"""<p>操作类型</p><ul><li>OPEN : 开通</li><li>CLOSE : 关闭</li></ul>
25167
24890
  :rtype: str
25168
24891
  """
25169
24892
  return self._Operate
@@ -25174,12 +24897,7 @@ class ModifyExtendedServiceRequest(AbstractModel):
25174
24897
 
25175
24898
  @property
25176
24899
  def Endpoint(self):
25177
- r"""链接跳转类型,支持以下类型
25178
- <ul>
25179
- <li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
25180
- <li>APP : 第三方APP或小程序跳转电子签小程序</li>
25181
- <li>WEIXIN_QRCODE_URL:直接跳转至电子签小程序的二维码链接,无需通过中转页。<font color="red">您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。</font></li>
25182
- </ul>
24900
+ r"""<p>链接跳转类型,支持以下类型</p><ul><li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li><li>APP : 第三方APP或小程序跳转电子签小程序</li><li>WEIXIN_QRCODE_URL:直接跳转至电子签小程序的二维码链接,无需通过中转页。<font color="red">您需要自行将其转换为二维码,使用微信扫码后可直接进入。请注意,直接点击链接是无效的。</font></li></ul>
25183
24901
  :rtype: str
25184
24902
  """
25185
24903
  return self._Endpoint
@@ -25213,13 +24931,7 @@ class ModifyExtendedServiceResponse(AbstractModel):
25213
24931
 
25214
24932
  def __init__(self):
25215
24933
  r"""
25216
- :param _OperateUrl: 操作跳转链接
25217
- <ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li>
25218
- <li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li>
25219
- <li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color="red"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li>
25220
- </ul>
25221
-
25222
-
24934
+ :param _OperateUrl: <p>操作跳转链接</p><ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li><li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li><li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业授权签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color="red"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li></ul>
25223
24935
  :type OperateUrl: str
25224
24936
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
25225
24937
  :type RequestId: str
@@ -25229,13 +24941,7 @@ class ModifyExtendedServiceResponse(AbstractModel):
25229
24941
 
25230
24942
  @property
25231
24943
  def OperateUrl(self):
25232
- r"""操作跳转链接
25233
- <ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li>
25234
- <li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li>
25235
- <li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业自动签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color="red"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li>
25236
- </ul>
25237
-
25238
-
24944
+ r"""<p>操作跳转链接</p><ul><li><strong>链接有效期:</strong> 跳转链接的有效期为24小时。</li><li><strong>没有返回链接的情形:</strong> 如果在操作时没有返回跳转链接,说明此次操作无需进行跳转,服务将会直接被开通或关闭。</li><li><strong>返回链接的情形:</strong> 当操作类型为<b>OPEN(开通服务)</b>,并且扩展服务类型为<b>AUTO_SIGN( 企业授权签署)</b>、<b>DOWNLOAD_FLOW(授权渠道下载合同)</b>时,系统将返回一个操作链接。收到操作链接后,贵方需主动联系超级管理员(超管)或法人。<font color="red"><b>由超管或法人点击链接</b></font>,以完成服务的开通操作。</li></ul>
25239
24945
  :rtype: str
25240
24946
  """
25241
24947
  return self._OperateUrl
@@ -25628,7 +25334,7 @@ class ModifyPartnerAutoSignAuthUrlRequest(AbstractModel):
25628
25334
  :type AuthorizedOrganizationId: str
25629
25335
  :param _AuthorizedOrganizationName: <p>被授企业名称/授权方企业的名字,如果是企业之间授权和AuthorizedOrganizationId二选一传入即可。请确认该名称与企业营业执照中注册的名称一致。</p><p>注: </p><ol><li>如果名称中包含英文括号(),请使用中文括号()代替。</li><li>被授权企业必须和当前企业在同一应用号下</li></ol>
25630
25336
  :type AuthorizedOrganizationName: str
25631
- :param _PlatformAppAuthorization: <p>是否给平台应用授权</p><ul><li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li><li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li></ul><p> 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。</p>
25337
+ :param _PlatformAppAuthorization: <p>是否给平台应用授权<ul><li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li><li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li></ul> 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客“授权签”】白名单,请联系运营经理开通。</p>
25632
25338
  :type PlatformAppAuthorization: bool
25633
25339
  :param _AuthToMe: <p>在处理授权关系时,授权的方向</p><ul><li><strong>false</strong>(默认值):表示我方授权他方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【被授权方】的企业名称,即接收授权的企业。</li><li><strong>true</strong>:表示他方授权我方。在这种情况下,<code>AuthorizedOrganizationName</code> 代表的是【授权方】的企业名称,即提供授权的企业。</li></ul>
25634
25340
  :type AuthToMe: bool
@@ -25680,7 +25386,7 @@ class ModifyPartnerAutoSignAuthUrlRequest(AbstractModel):
25680
25386
 
25681
25387
  @property
25682
25388
  def PlatformAppAuthorization(self):
25683
- r"""<p>是否给平台应用授权</p><ul><li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li><li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li></ul><p> 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客自动签署】白名单,请联系运营经理开通。</p>
25389
+ r"""<p>是否给平台应用授权<ul><li><strong>true</strong>: 表示是,授权平台应用。在此情况下,无需设置<code>AuthorizedOrganizationId</code>和<code>AuthorizedOrganizationName</code>。</li><li><strong>false</strong>: (默认)表示否,不是授权平台应用。</li></ul> 注:授权给平台应用需要开通【基于子客授权第三方应用可文件发起子客“授权签”】白名单,请联系运营经理开通。</p>
25684
25390
  :rtype: bool
25685
25391
  """
25686
25392
  return self._PlatformAppAuthorization
@@ -25823,32 +25529,17 @@ class NeedReviewApproverInfo(AbstractModel):
25823
25529
 
25824
25530
  def __init__(self):
25825
25531
  r"""
25826
- :param _ApproverType: 签署方经办人的类型,支持以下类型
25827
- <ul><li> ORGANIZATION 企业(含企业自动签)</li>
25828
- <li>PERSON 个人(含个人自动签)</li></ul>
25532
+ :param _ApproverType: <p>签署方经办人的类型,支持以下类型<ul><li> ORGANIZATION 企业(含企业“授权签”)</li><li>PERSON 个人(含个人“授权签”)</li></ul></p>
25829
25533
  :type ApproverType: str
25830
- :param _ApproverName: 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
25534
+ :param _ApproverName: <p>签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
25831
25535
  :type ApproverName: str
25832
- :param _ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
25536
+ :param _ApproverMobile: <p>签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。</p>
25833
25537
  :type ApproverMobile: str
25834
- :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
25835
- <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
25836
- <li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
25837
- <li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
25838
- <li>OTHER_CARD_TYPE 其他证件</li></ul>
25839
-
25840
- 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
25538
+ :param _ApproverIdCardType: <p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li><li>OTHER_CARD_TYPE 其他证件</li></ul><p>注: <code>其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
25841
25539
  :type ApproverIdCardType: str
25842
- :param _ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
25843
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
25844
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li>
25845
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
25540
+ :param _ApproverIdCardNumber: <p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
25846
25541
  :type ApproverIdCardNumber: str
25847
- :param _OrganizationName: 组织机构名称。
25848
- 请确认该名称与企业营业执照中注册的名称一致。
25849
- 如果名称中包含英文括号(),请使用中文括号()代替。
25850
- 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
25851
-
25542
+ :param _OrganizationName: <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。</p>
25852
25543
  :type OrganizationName: str
25853
25544
  """
25854
25545
  self._ApproverType = None
@@ -25860,9 +25551,7 @@ class NeedReviewApproverInfo(AbstractModel):
25860
25551
 
25861
25552
  @property
25862
25553
  def ApproverType(self):
25863
- r"""签署方经办人的类型,支持以下类型
25864
- <ul><li> ORGANIZATION 企业(含企业自动签)</li>
25865
- <li>PERSON 个人(含个人自动签)</li></ul>
25554
+ r"""<p>签署方经办人的类型,支持以下类型<ul><li> ORGANIZATION 企业(含企业“授权签”)</li><li>PERSON 个人(含个人“授权签”)</li></ul></p>
25866
25555
  :rtype: str
25867
25556
  """
25868
25557
  return self._ApproverType
@@ -25873,7 +25562,7 @@ class NeedReviewApproverInfo(AbstractModel):
25873
25562
 
25874
25563
  @property
25875
25564
  def ApproverName(self):
25876
- r"""签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
25565
+ r"""<p>签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
25877
25566
  :rtype: str
25878
25567
  """
25879
25568
  return self._ApproverName
@@ -25884,7 +25573,7 @@ class NeedReviewApproverInfo(AbstractModel):
25884
25573
 
25885
25574
  @property
25886
25575
  def ApproverMobile(self):
25887
- r"""签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
25576
+ r"""<p>签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。</p>
25888
25577
  :rtype: str
25889
25578
  """
25890
25579
  return self._ApproverMobile
@@ -25895,13 +25584,7 @@ class NeedReviewApproverInfo(AbstractModel):
25895
25584
 
25896
25585
  @property
25897
25586
  def ApproverIdCardType(self):
25898
- r"""签署方经办人的证件类型,支持以下类型
25899
- <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
25900
- <li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
25901
- <li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
25902
- <li>OTHER_CARD_TYPE 其他证件</li></ul>
25903
-
25904
- 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
25587
+ r"""<p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li><li>OTHER_CARD_TYPE 其他证件</li></ul><p>注: <code>其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。</code></p>
25905
25588
  :rtype: str
25906
25589
  """
25907
25590
  return self._ApproverIdCardType
@@ -25912,10 +25595,7 @@ class NeedReviewApproverInfo(AbstractModel):
25912
25595
 
25913
25596
  @property
25914
25597
  def ApproverIdCardNumber(self):
25915
- r"""签署方经办人的证件号码,应符合以下规则
25916
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
25917
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li>
25918
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
25598
+ r"""<p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
25919
25599
  :rtype: str
25920
25600
  """
25921
25601
  return self._ApproverIdCardNumber
@@ -25926,11 +25606,7 @@ class NeedReviewApproverInfo(AbstractModel):
25926
25606
 
25927
25607
  @property
25928
25608
  def OrganizationName(self):
25929
- r"""组织机构名称。
25930
- 请确认该名称与企业营业执照中注册的名称一致。
25931
- 如果名称中包含英文括号(),请使用中文括号()代替。
25932
- 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
25933
-
25609
+ r"""<p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。</p>
25934
25610
  :rtype: str
25935
25611
  """
25936
25612
  return self._OrganizationName
@@ -28795,51 +28471,31 @@ class ReleasedApprover(AbstractModel):
28795
28471
 
28796
28472
  def __init__(self):
28797
28473
  r"""
28798
- :param _ApproverNumber: 签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。
28799
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
28474
+ :param _ApproverNumber: <p>签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。<br>可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。</p>
28800
28475
  :type ApproverNumber: int
28801
- :param _ApproverType: 指定签署人类型,目前支持
28802
- <ul><li> **ORGANIZATION**:企业(默认值)</li>
28803
- <li> **ENTERPRISESERVER**:企业静默签</li></ul>
28476
+ :param _ApproverType: <p>指定签署人类型,目前支持<ul><li> <strong>ORGANIZATION</strong>:企业(默认值)</li><li> <strong>ENTERPRISESERVER</strong>:企业“授权签”</li></ul></p>
28804
28477
  :type ApproverType: str
28805
- :param _ReleasedApproverRecipientId: <font color="red">【已废弃】</font>请用ApproverNumber来指定替换的参与方的位置
28478
+ :param _ReleasedApproverRecipientId: <p><font color="red">【已废弃】</font>请用ApproverNumber来指定替换的参与方的位置</p>
28806
28479
  :type ReleasedApproverRecipientId: str
28807
- :param _Name: 签署人姓名,最大长度50个字。
28480
+ :param _Name: <p>签署人姓名,最大长度50个字。</p>
28808
28481
  :type Name: str
28809
- :param _IdCardType: 签署方经办人的证件类型,支持以下类型
28810
- <ul><li>ID_CARD : 中国大陆居民身份证(默认值)</li>
28811
- <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
28812
- <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
28482
+ :param _IdCardType: <p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证(默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
28813
28483
  :type IdCardType: str
28814
- :param _IdCardNumber: 证件号码,应符合以下规则
28815
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
28816
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。
28817
- </li>
28818
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
28484
+ :param _IdCardNumber: <p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
28819
28485
  :type IdCardNumber: str
28820
- :param _Mobile: 签署人手机号。
28486
+ :param _Mobile: <p>签署人手机号。</p>
28821
28487
  :type Mobile: str
28822
- :param _OrganizationName: 组织机构名称。
28823
- 请确认该名称与企业营业执照中注册的名称一致。
28824
- 如果名称中包含英文括号(),请使用中文括号()代替。
28825
- 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
28488
+ :param _OrganizationName: <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。</p>
28826
28489
  :type OrganizationName: str
28827
- :param _OrganizationOpenId: 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。
28828
- <font color="red">当为子客企业指定经办人时,此OrganizationOpenId必传。</font>
28490
+ :param _OrganizationOpenId: <p>第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。<br><font color="red">当为子客企业指定经办人时,此OrganizationOpenId必传。</font></p>
28829
28491
  :type OrganizationOpenId: str
28830
- :param _OpenId: 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。
28831
- <font color="red">当签署方为同一第三方平台下的员工时,此OpenId必传。</font>
28492
+ :param _OpenId: <p>第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。<br><font color="red">当签署方为同一第三方平台下的员工时,此OpenId必传。</font></p>
28832
28493
  :type OpenId: str
28833
- :param _ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件类型
28834
- <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
28835
- <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
28494
+ :param _ApproverSignComponentType: <p>签署控件类型,支持自定义企业签署方的签署控件类型</p><ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li><li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
28836
28495
  :type ApproverSignComponentType: str
28837
- :param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
28838
- 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
28839
-
28840
- ![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)
28496
+ :param _ApproverSignRole: <p>参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫<code>甲方</code>,第二个叫<code>乙方</code>, 第三个叫<code>丙方</code>,以此类推。<br>如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png" alt="image"></p>
28841
28497
  :type ApproverSignRole: str
28842
- :param _ApproverSignSealId: 印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署
28498
+ :param _ApproverSignSealId: <p>印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署</p>
28843
28499
  :type ApproverSignSealId: str
28844
28500
  """
28845
28501
  self._ApproverNumber = None
@@ -28858,8 +28514,7 @@ class ReleasedApprover(AbstractModel):
28858
28514
 
28859
28515
  @property
28860
28516
  def ApproverNumber(self):
28861
- r"""签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。
28862
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
28517
+ r"""<p>签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。<br>可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。</p>
28863
28518
  :rtype: int
28864
28519
  """
28865
28520
  return self._ApproverNumber
@@ -28870,9 +28525,7 @@ class ReleasedApprover(AbstractModel):
28870
28525
 
28871
28526
  @property
28872
28527
  def ApproverType(self):
28873
- r"""指定签署人类型,目前支持
28874
- <ul><li> **ORGANIZATION**:企业(默认值)</li>
28875
- <li> **ENTERPRISESERVER**:企业静默签</li></ul>
28528
+ r"""<p>指定签署人类型,目前支持<ul><li> <strong>ORGANIZATION</strong>:企业(默认值)</li><li> <strong>ENTERPRISESERVER</strong>:企业“授权签”</li></ul></p>
28876
28529
  :rtype: str
28877
28530
  """
28878
28531
  return self._ApproverType
@@ -28883,7 +28536,7 @@ class ReleasedApprover(AbstractModel):
28883
28536
 
28884
28537
  @property
28885
28538
  def ReleasedApproverRecipientId(self):
28886
- r"""<font color="red">【已废弃】</font>请用ApproverNumber来指定替换的参与方的位置
28539
+ r"""<p><font color="red">【已废弃】</font>请用ApproverNumber来指定替换的参与方的位置</p>
28887
28540
  :rtype: str
28888
28541
  """
28889
28542
  return self._ReleasedApproverRecipientId
@@ -28894,7 +28547,7 @@ class ReleasedApprover(AbstractModel):
28894
28547
 
28895
28548
  @property
28896
28549
  def Name(self):
28897
- r"""签署人姓名,最大长度50个字。
28550
+ r"""<p>签署人姓名,最大长度50个字。</p>
28898
28551
  :rtype: str
28899
28552
  """
28900
28553
  return self._Name
@@ -28905,10 +28558,7 @@ class ReleasedApprover(AbstractModel):
28905
28558
 
28906
28559
  @property
28907
28560
  def IdCardType(self):
28908
- r"""签署方经办人的证件类型,支持以下类型
28909
- <ul><li>ID_CARD : 中国大陆居民身份证(默认值)</li>
28910
- <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
28911
- <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
28561
+ r"""<p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证(默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
28912
28562
  :rtype: str
28913
28563
  """
28914
28564
  return self._IdCardType
@@ -28919,11 +28569,7 @@ class ReleasedApprover(AbstractModel):
28919
28569
 
28920
28570
  @property
28921
28571
  def IdCardNumber(self):
28922
- r"""证件号码,应符合以下规则
28923
- <ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
28924
- <li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。
28925
- </li>
28926
- <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
28572
+ r"""<p>证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
28927
28573
  :rtype: str
28928
28574
  """
28929
28575
  return self._IdCardNumber
@@ -28934,7 +28580,7 @@ class ReleasedApprover(AbstractModel):
28934
28580
 
28935
28581
  @property
28936
28582
  def Mobile(self):
28937
- r"""签署人手机号。
28583
+ r"""<p>签署人手机号。</p>
28938
28584
  :rtype: str
28939
28585
  """
28940
28586
  return self._Mobile
@@ -28945,10 +28591,7 @@ class ReleasedApprover(AbstractModel):
28945
28591
 
28946
28592
  @property
28947
28593
  def OrganizationName(self):
28948
- r"""组织机构名称。
28949
- 请确认该名称与企业营业执照中注册的名称一致。
28950
- 如果名称中包含英文括号(),请使用中文括号()代替。
28951
- 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
28594
+ r"""<p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。</p>
28952
28595
  :rtype: str
28953
28596
  """
28954
28597
  return self._OrganizationName
@@ -28959,8 +28602,7 @@ class ReleasedApprover(AbstractModel):
28959
28602
 
28960
28603
  @property
28961
28604
  def OrganizationOpenId(self):
28962
- r"""第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。
28963
- <font color="red">当为子客企业指定经办人时,此OrganizationOpenId必传。</font>
28605
+ r"""<p>第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。<br><font color="red">当为子客企业指定经办人时,此OrganizationOpenId必传。</font></p>
28964
28606
  :rtype: str
28965
28607
  """
28966
28608
  return self._OrganizationOpenId
@@ -28971,8 +28613,7 @@ class ReleasedApprover(AbstractModel):
28971
28613
 
28972
28614
  @property
28973
28615
  def OpenId(self):
28974
- r"""第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。
28975
- <font color="red">当签署方为同一第三方平台下的员工时,此OpenId必传。</font>
28616
+ r"""<p>第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。<br><font color="red">当签署方为同一第三方平台下的员工时,此OpenId必传。</font></p>
28976
28617
  :rtype: str
28977
28618
  """
28978
28619
  return self._OpenId
@@ -28983,9 +28624,7 @@ class ReleasedApprover(AbstractModel):
28983
28624
 
28984
28625
  @property
28985
28626
  def ApproverSignComponentType(self):
28986
- r"""签署控件类型,支持自定义企业签署方的签署控件类型
28987
- <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
28988
- <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
28627
+ r"""<p>签署控件类型,支持自定义企业签署方的签署控件类型</p><ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li><li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
28989
28628
  :rtype: str
28990
28629
  """
28991
28630
  return self._ApproverSignComponentType
@@ -28996,10 +28635,7 @@ class ReleasedApprover(AbstractModel):
28996
28635
 
28997
28636
  @property
28998
28637
  def ApproverSignRole(self):
28999
- r"""参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
29000
- 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
29001
-
29002
- ![image](https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png)
28638
+ r"""<p>参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫<code>甲方</code>,第二个叫<code>乙方</code>, 第三个叫<code>丙方</code>,以此类推。<br>如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。</p><p><img src="https://qcloudimg.tencent-cloud.cn/raw/973a820ab66d1ce57082c160c2b2d44a.png" alt="image"></p>
29003
28639
  :rtype: str
29004
28640
  """
29005
28641
  return self._ApproverSignRole
@@ -29010,7 +28646,7 @@ class ReleasedApprover(AbstractModel):
29010
28646
 
29011
28647
  @property
29012
28648
  def ApproverSignSealId(self):
29013
- r"""印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署
28649
+ r"""<p>印章Id,签署控件类型为印章时,用于指定本企业签署方在解除协议中使用那个印章进行签署</p>
29014
28650
  :rtype: str
29015
28651
  """
29016
28652
  return self._ApproverSignSealId
@@ -30517,62 +30153,41 @@ class TemplateInfo(AbstractModel):
30517
30153
 
30518
30154
  def __init__(self):
30519
30155
  r"""
30520
- :param _TemplateId: 模板ID,模板的唯一标识
30156
+ :param _TemplateId: <p>模板ID,模板的唯一标识</p>
30521
30157
  :type TemplateId: str
30522
- :param _TemplateName: 模板名
30158
+ :param _TemplateName: <p>模板名</p>
30523
30159
  :type TemplateName: str
30524
- :param _Description: 模板描述信息
30160
+ :param _Description: <p>模板描述信息</p>
30525
30161
  :type Description: str
30526
- :param _Components: 模板的填充控件列表
30527
-
30528
- [点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
30162
+ :param _Components: <p>模板的填充控件列表</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png">点击查看在模板中配置的填充控件的样子</a></p>
30529
30163
  :type Components: list of Component
30530
- :param _Recipients: 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
30531
-
30532
- [点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
30533
-
30534
-
30164
+ :param _Recipients: <p>此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png">点击查看在模板中配置的签署参与方角色列表的样子</a></p>
30535
30165
  :type Recipients: list of Recipient
30536
- :param _SignComponents: 此模板中的签署控件列表
30537
-
30538
- [点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
30166
+ :param _SignComponents: <p>此模板中的签署控件列表</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png">点击查看在模板中配置的签署控件的样子</a></p>
30539
30167
  :type SignComponents: list of Component
30540
- :param _TemplateType: 模板类型可以分为以下两种:
30541
-
30542
- <b>1</b>:带有<b>本企业自动签署</b>的模板,即签署过程无需签署人手动操作,系统自动完成签署。
30543
- <b>3</b>:普通模板,即签署人需要手动进行签署操作。
30168
+ :param _TemplateType: <p>模板类型可以分为以下两种:<b>1</b>:带有<b>本企业“授权签”</b>的模板,即签署过程无需签署人手动操作,系统自动完成签署。<b>3</b>:普通模板,即签署人需要手动进行签署操作。</p>
30544
30169
  :type TemplateType: int
30545
- :param _IsPromoter: 是否是发起人 ,已弃用
30170
+ :param _IsPromoter: <p>是否是发起人 ,已弃用</p>
30546
30171
  :type IsPromoter: bool
30547
- :param _Creator: 模板的创建者名字
30172
+ :param _Creator: <p>模板的创建者名字</p>
30548
30173
  :type Creator: str
30549
- :param _CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
30174
+ :param _CreatedOn: <p>模板创建的时间戳,格式为Unix标准时间戳(秒)</p>
30550
30175
  :type CreatedOn: int
30551
- :param _PreviewUrl: 模板的 H5 预览链接,有效期为 5 分钟。
30552
- 您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
30553
-
30554
- 注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
30176
+ :param _PreviewUrl: <p>模板的 H5 预览链接,有效期为 5 分钟。<br>您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。</p><p>注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。</p>
30555
30177
  :type PreviewUrl: str
30556
- :param _PdfUrl: 第三方应用集成-模板PDF文件链接,有效期5分钟。
30557
- 请求参数WithPdfUrl=true时返回
30558
- (此功能开放需要联系客户经理)。
30178
+ :param _PdfUrl: <p>第三方应用集成-模板PDF文件链接,有效期5分钟。<br>请求参数WithPdfUrl=true时返回<br>(此功能开放需要联系客户经理)。</p>
30559
30179
  :type PdfUrl: str
30560
- :param _ChannelTemplateId: 本模板关联的第三方应用平台企业模板ID
30180
+ :param _ChannelTemplateId: <p>本模板关联的第三方应用平台企业模板ID</p>
30561
30181
  :type ChannelTemplateId: str
30562
- :param _ChannelTemplateName: 本模板关联的三方应用平台平台企业模板名称
30182
+ :param _ChannelTemplateName: <p>本模板关联的三方应用平台平台企业模板名称</p>
30563
30183
  :type ChannelTemplateName: str
30564
- :param _ChannelAutoSave: 0-需要子客企业手动领取平台企业的模板(默认);
30565
- 1-平台自动设置子客模板
30184
+ :param _ChannelAutoSave: <p>0-需要子客企业手动领取平台企业的模板(默认);<br>1-平台自动设置子客模板</p>
30566
30185
  :type ChannelAutoSave: int
30567
- :param _TemplateVersion: 模板版本,由全数字字符组成。
30568
- 默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。
30186
+ :param _TemplateVersion: <p>模板版本,由全数字字符组成。<br>默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。</p>
30569
30187
  :type TemplateVersion: str
30570
- :param _Available: 模板可用状态的取值通常为以下两种:
30571
-
30572
- <ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li>
30573
- <li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>
30188
+ :param _Available: <p>模板可用状态的取值通常为以下两种:</p><ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li><li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>
30574
30189
  :type Available: int
30575
- :param _UserFlowType: 模板的用户合同类型
30190
+ :param _UserFlowType: <p>模板的用户合同类型</p>
30576
30191
  :type UserFlowType: :class:`tencentcloud.essbasic.v20210526.models.UserFlowType`
30577
30192
  """
30578
30193
  self._TemplateId = None
@@ -30596,7 +30211,7 @@ class TemplateInfo(AbstractModel):
30596
30211
 
30597
30212
  @property
30598
30213
  def TemplateId(self):
30599
- r"""模板ID,模板的唯一标识
30214
+ r"""<p>模板ID,模板的唯一标识</p>
30600
30215
  :rtype: str
30601
30216
  """
30602
30217
  return self._TemplateId
@@ -30607,7 +30222,7 @@ class TemplateInfo(AbstractModel):
30607
30222
 
30608
30223
  @property
30609
30224
  def TemplateName(self):
30610
- r"""模板名
30225
+ r"""<p>模板名</p>
30611
30226
  :rtype: str
30612
30227
  """
30613
30228
  return self._TemplateName
@@ -30618,7 +30233,7 @@ class TemplateInfo(AbstractModel):
30618
30233
 
30619
30234
  @property
30620
30235
  def Description(self):
30621
- r"""模板描述信息
30236
+ r"""<p>模板描述信息</p>
30622
30237
  :rtype: str
30623
30238
  """
30624
30239
  return self._Description
@@ -30629,9 +30244,7 @@ class TemplateInfo(AbstractModel):
30629
30244
 
30630
30245
  @property
30631
30246
  def Components(self):
30632
- r"""模板的填充控件列表
30633
-
30634
- [点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
30247
+ r"""<p>模板的填充控件列表</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png">点击查看在模板中配置的填充控件的样子</a></p>
30635
30248
  :rtype: list of Component
30636
30249
  """
30637
30250
  return self._Components
@@ -30642,11 +30255,7 @@ class TemplateInfo(AbstractModel):
30642
30255
 
30643
30256
  @property
30644
30257
  def Recipients(self):
30645
- r"""此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
30646
-
30647
- [点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
30648
-
30649
-
30258
+ r"""<p>此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png">点击查看在模板中配置的签署参与方角色列表的样子</a></p>
30650
30259
  :rtype: list of Recipient
30651
30260
  """
30652
30261
  return self._Recipients
@@ -30657,9 +30266,7 @@ class TemplateInfo(AbstractModel):
30657
30266
 
30658
30267
  @property
30659
30268
  def SignComponents(self):
30660
- r"""此模板中的签署控件列表
30661
-
30662
- [点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
30269
+ r"""<p>此模板中的签署控件列表</p><p><a href="https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png">点击查看在模板中配置的签署控件的样子</a></p>
30663
30270
  :rtype: list of Component
30664
30271
  """
30665
30272
  return self._SignComponents
@@ -30670,10 +30277,7 @@ class TemplateInfo(AbstractModel):
30670
30277
 
30671
30278
  @property
30672
30279
  def TemplateType(self):
30673
- r"""模板类型可以分为以下两种:
30674
-
30675
- <b>1</b>:带有<b>本企业自动签署</b>的模板,即签署过程无需签署人手动操作,系统自动完成签署。
30676
- <b>3</b>:普通模板,即签署人需要手动进行签署操作。
30280
+ r"""<p>模板类型可以分为以下两种:<b>1</b>:带有<b>本企业“授权签”</b>的模板,即签署过程无需签署人手动操作,系统自动完成签署。<b>3</b>:普通模板,即签署人需要手动进行签署操作。</p>
30677
30281
  :rtype: int
30678
30282
  """
30679
30283
  return self._TemplateType
@@ -30686,7 +30290,7 @@ class TemplateInfo(AbstractModel):
30686
30290
  def IsPromoter(self):
30687
30291
  warnings.warn("parameter `IsPromoter` is deprecated", DeprecationWarning)
30688
30292
 
30689
- r"""是否是发起人 ,已弃用
30293
+ r"""<p>是否是发起人 ,已弃用</p>
30690
30294
  :rtype: bool
30691
30295
  """
30692
30296
  return self._IsPromoter
@@ -30699,7 +30303,7 @@ class TemplateInfo(AbstractModel):
30699
30303
 
30700
30304
  @property
30701
30305
  def Creator(self):
30702
- r"""模板的创建者名字
30306
+ r"""<p>模板的创建者名字</p>
30703
30307
  :rtype: str
30704
30308
  """
30705
30309
  return self._Creator
@@ -30710,7 +30314,7 @@ class TemplateInfo(AbstractModel):
30710
30314
 
30711
30315
  @property
30712
30316
  def CreatedOn(self):
30713
- r"""模板创建的时间戳,格式为Unix标准时间戳(秒)
30317
+ r"""<p>模板创建的时间戳,格式为Unix标准时间戳(秒)</p>
30714
30318
  :rtype: int
30715
30319
  """
30716
30320
  return self._CreatedOn
@@ -30721,10 +30325,7 @@ class TemplateInfo(AbstractModel):
30721
30325
 
30722
30326
  @property
30723
30327
  def PreviewUrl(self):
30724
- r"""模板的 H5 预览链接,有效期为 5 分钟。
30725
- 您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
30726
-
30727
- 注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
30328
+ r"""<p>模板的 H5 预览链接,有效期为 5 分钟。<br>您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。</p><p>注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。</p>
30728
30329
  :rtype: str
30729
30330
  """
30730
30331
  return self._PreviewUrl
@@ -30735,9 +30336,7 @@ class TemplateInfo(AbstractModel):
30735
30336
 
30736
30337
  @property
30737
30338
  def PdfUrl(self):
30738
- r"""第三方应用集成-模板PDF文件链接,有效期5分钟。
30739
- 请求参数WithPdfUrl=true时返回
30740
- (此功能开放需要联系客户经理)。
30339
+ r"""<p>第三方应用集成-模板PDF文件链接,有效期5分钟。<br>请求参数WithPdfUrl=true时返回<br>(此功能开放需要联系客户经理)。</p>
30741
30340
  :rtype: str
30742
30341
  """
30743
30342
  return self._PdfUrl
@@ -30748,7 +30347,7 @@ class TemplateInfo(AbstractModel):
30748
30347
 
30749
30348
  @property
30750
30349
  def ChannelTemplateId(self):
30751
- r"""本模板关联的第三方应用平台企业模板ID
30350
+ r"""<p>本模板关联的第三方应用平台企业模板ID</p>
30752
30351
  :rtype: str
30753
30352
  """
30754
30353
  return self._ChannelTemplateId
@@ -30759,7 +30358,7 @@ class TemplateInfo(AbstractModel):
30759
30358
 
30760
30359
  @property
30761
30360
  def ChannelTemplateName(self):
30762
- r"""本模板关联的三方应用平台平台企业模板名称
30361
+ r"""<p>本模板关联的三方应用平台平台企业模板名称</p>
30763
30362
  :rtype: str
30764
30363
  """
30765
30364
  return self._ChannelTemplateName
@@ -30770,8 +30369,7 @@ class TemplateInfo(AbstractModel):
30770
30369
 
30771
30370
  @property
30772
30371
  def ChannelAutoSave(self):
30773
- r"""0-需要子客企业手动领取平台企业的模板(默认);
30774
- 1-平台自动设置子客模板
30372
+ r"""<p>0-需要子客企业手动领取平台企业的模板(默认);<br>1-平台自动设置子客模板</p>
30775
30373
  :rtype: int
30776
30374
  """
30777
30375
  return self._ChannelAutoSave
@@ -30782,8 +30380,7 @@ class TemplateInfo(AbstractModel):
30782
30380
 
30783
30381
  @property
30784
30382
  def TemplateVersion(self):
30785
- r"""模板版本,由全数字字符组成。
30786
- 默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。
30383
+ r"""<p>模板版本,由全数字字符组成。<br>默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。</p>
30787
30384
  :rtype: str
30788
30385
  """
30789
30386
  return self._TemplateVersion
@@ -30794,10 +30391,7 @@ class TemplateInfo(AbstractModel):
30794
30391
 
30795
30392
  @property
30796
30393
  def Available(self):
30797
- r"""模板可用状态的取值通常为以下两种:
30798
-
30799
- <ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li>
30800
- <li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>
30394
+ r"""<p>模板可用状态的取值通常为以下两种:</p><ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li><li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>
30801
30395
  :rtype: int
30802
30396
  """
30803
30397
  return self._Available
@@ -30808,7 +30402,7 @@ class TemplateInfo(AbstractModel):
30808
30402
 
30809
30403
  @property
30810
30404
  def UserFlowType(self):
30811
- r"""模板的用户合同类型
30405
+ r"""<p>模板的用户合同类型</p>
30812
30406
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserFlowType`
30813
30407
  """
30814
30408
  return self._UserFlowType