tencentcloud-sdk-python-essbasic 3.1.166__py2.py3-none-any.whl → 3.1.171__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.
- tencentcloud/__init__.py +1 -1
- tencentcloud/essbasic/v20210526/essbasic_client.py +52 -128
- tencentcloud/essbasic/v20210526/essbasic_client_async.py +52 -118
- tencentcloud/essbasic/v20210526/models.py +74 -594
- {tencentcloud_sdk_python_essbasic-3.1.166.dist-info → tencentcloud_sdk_python_essbasic-3.1.171.dist-info}/METADATA +2 -2
- {tencentcloud_sdk_python_essbasic-3.1.166.dist-info → tencentcloud_sdk_python_essbasic-3.1.171.dist-info}/RECORD +8 -8
- {tencentcloud_sdk_python_essbasic-3.1.166.dist-info → tencentcloud_sdk_python_essbasic-3.1.171.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_essbasic-3.1.166.dist-info → tencentcloud_sdk_python_essbasic-3.1.171.dist-info}/top_level.txt +0 -0
|
@@ -430,6 +430,8 @@ class ApproverOption(AbstractModel):
|
|
|
430
430
|
:type ForbidAddSignDate: bool
|
|
431
431
|
:param _ApproverMobileMode: <p>签署人手机号传参模式</p><p>枚举值:</p><ul><li>REPLACE: 接受已有认证手机号并替换</li><li>GIVEN: 以客户入参输入手机号为主</li><li>VALIDATE: 若与认证手机号不一致则报错</li><li>"": 不走手机号传参模式</li></ul><p>默认值:""</p><p>会触发手机号传参模式的前提是:签署人是指定了具体身份信息的</p><ul><li>渠道方签署人不会触发</li><li>非渠道方签署人在指定签署人姓名,证件号的情况下会触发</li></ul>
|
|
432
432
|
:type ApproverMobileMode: str
|
|
433
|
+
:param _AddSignComponentUseSealSize: <p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件(SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL)时,「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值:</p><ul><li>0: 默认关闭,可开启。与现网一致</li><li>1: 关闭且置灰——按控件默认的4.2cm尺寸盖章,签署方无法开启开关</li><li>2: 默认开启且可修改——默认按印章实际尺寸盖章,签署方可手动关闭</li><li>3: 开启且置灰——强制按印章实际尺寸盖章,签署方不可修改</li></ul>
|
|
434
|
+
:type AddSignComponentUseSealSize: int
|
|
433
435
|
"""
|
|
434
436
|
self._NoRefuse = None
|
|
435
437
|
self._NoTransfer = None
|
|
@@ -438,6 +440,7 @@ class ApproverOption(AbstractModel):
|
|
|
438
440
|
self._FlowReadLimit = None
|
|
439
441
|
self._ForbidAddSignDate = None
|
|
440
442
|
self._ApproverMobileMode = None
|
|
443
|
+
self._AddSignComponentUseSealSize = None
|
|
441
444
|
|
|
442
445
|
@property
|
|
443
446
|
def NoRefuse(self):
|
|
@@ -516,6 +519,17 @@ class ApproverOption(AbstractModel):
|
|
|
516
519
|
def ApproverMobileMode(self, ApproverMobileMode):
|
|
517
520
|
self._ApproverMobileMode = ApproverMobileMode
|
|
518
521
|
|
|
522
|
+
@property
|
|
523
|
+
def AddSignComponentUseSealSize(self):
|
|
524
|
+
r"""<p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件(SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL)时,「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值:</p><ul><li>0: 默认关闭,可开启。与现网一致</li><li>1: 关闭且置灰——按控件默认的4.2cm尺寸盖章,签署方无法开启开关</li><li>2: 默认开启且可修改——默认按印章实际尺寸盖章,签署方可手动关闭</li><li>3: 开启且置灰——强制按印章实际尺寸盖章,签署方不可修改</li></ul>
|
|
525
|
+
:rtype: int
|
|
526
|
+
"""
|
|
527
|
+
return self._AddSignComponentUseSealSize
|
|
528
|
+
|
|
529
|
+
@AddSignComponentUseSealSize.setter
|
|
530
|
+
def AddSignComponentUseSealSize(self, AddSignComponentUseSealSize):
|
|
531
|
+
self._AddSignComponentUseSealSize = AddSignComponentUseSealSize
|
|
532
|
+
|
|
519
533
|
|
|
520
534
|
def _deserialize(self, params):
|
|
521
535
|
self._NoRefuse = params.get("NoRefuse")
|
|
@@ -525,6 +539,7 @@ class ApproverOption(AbstractModel):
|
|
|
525
539
|
self._FlowReadLimit = params.get("FlowReadLimit")
|
|
526
540
|
self._ForbidAddSignDate = params.get("ForbidAddSignDate")
|
|
527
541
|
self._ApproverMobileMode = params.get("ApproverMobileMode")
|
|
542
|
+
self._AddSignComponentUseSealSize = params.get("AddSignComponentUseSealSize")
|
|
528
543
|
memeber_set = set(params.keys())
|
|
529
544
|
for name, value in vars(self).items():
|
|
530
545
|
property_name = name[1:]
|
|
@@ -967,49 +982,21 @@ class AutoSignConfig(AbstractModel):
|
|
|
967
982
|
|
|
968
983
|
def __init__(self):
|
|
969
984
|
r"""
|
|
970
|
-
:param _UserInfo:
|
|
985
|
+
:param _UserInfo: <p>自动签开通个人用户信息, 包括名字,身份证等</p>
|
|
971
986
|
:type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
|
|
972
|
-
:param _CertInfoCallback:
|
|
973
|
-
<ul><li>**false**: 不需要(默认)</li>
|
|
974
|
-
<li>**true**:需要</li></ul>
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
注:`该字段已经失效,请勿设置此参数。`
|
|
987
|
+
:param _CertInfoCallback: <p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
|
|
978
988
|
:type CertInfoCallback: bool
|
|
979
|
-
:param _UserDefineSeal:
|
|
980
|
-
<ul><li>**false**: 不能自己定义(默认)</li>
|
|
981
|
-
<li>**true**: 可以自己定义</li></ul>
|
|
989
|
+
:param _UserDefineSeal: <p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
|
|
982
990
|
:type UserDefineSeal: bool
|
|
983
|
-
:param _SealImgCallback:
|
|
984
|
-
<ul><li>**false**: 不需要(默认)</li>
|
|
985
|
-
<li>**true**: 需要</li></ul>
|
|
991
|
+
:param _SealImgCallback: <p>回调中是否需要自动签将要使用的印章(签名)图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
|
|
986
992
|
:type SealImgCallback: bool
|
|
987
|
-
:param _CallbackUrl:
|
|
993
|
+
:param _CallbackUrl: <p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
|
|
988
994
|
:type CallbackUrl: str
|
|
989
|
-
:param _VerifyChannels:
|
|
990
|
-
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
|
|
991
|
-
<li>**INSIGHT** : 慧眼人脸识别</li>
|
|
992
|
-
<li>**TELECOM** : 运营商三要素验证</li></ul>
|
|
993
|
-
注:
|
|
994
|
-
<ul><li>如果是小程序开通链接,仅支持传 WEIXINAPP。为空默认 WEIXINAPP</li>
|
|
995
|
-
<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
|
|
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:
|
|
998
|
-
|
|
999
|
-
<ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul>
|
|
1000
|
-
|
|
1001
|
-
注:`该字段已经失效,请勿设置此参数。`
|
|
997
|
+
:param _LicenseType: <p>设置用户开通自动签时是否绑定个人自动签账号许可。</p><ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
|
|
1002
998
|
:type LicenseType: int
|
|
1003
|
-
:param _JumpUrl:
|
|
1004
|
-
|
|
1005
|
-
注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
|
|
1006
|
-
|
|
1007
|
-
跳转场景:
|
|
1008
|
-
<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>
|
|
1009
|
-
<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
|
|
1010
|
-
|
|
1011
|
-
成功结果返回:
|
|
1012
|
-
若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如:qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
|
|
999
|
+
:param _JumpUrl: <p>开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。</p><p>注:<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景:</p><ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生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&result=success&from=tencent_ess</p>
|
|
1013
1000
|
:type JumpUrl: str
|
|
1014
1001
|
"""
|
|
1015
1002
|
self._UserInfo = None
|
|
@@ -1023,7 +1010,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1023
1010
|
|
|
1024
1011
|
@property
|
|
1025
1012
|
def UserInfo(self):
|
|
1026
|
-
r"""
|
|
1013
|
+
r"""<p>自动签开通个人用户信息, 包括名字,身份证等</p>
|
|
1027
1014
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
|
|
1028
1015
|
"""
|
|
1029
1016
|
return self._UserInfo
|
|
@@ -1034,12 +1021,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1034
1021
|
|
|
1035
1022
|
@property
|
|
1036
1023
|
def CertInfoCallback(self):
|
|
1037
|
-
r"""
|
|
1038
|
-
<ul><li>**false**: 不需要(默认)</li>
|
|
1039
|
-
<li>**true**:需要</li></ul>
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
注:`该字段已经失效,请勿设置此参数。`
|
|
1024
|
+
r"""<p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
|
|
1043
1025
|
:rtype: bool
|
|
1044
1026
|
"""
|
|
1045
1027
|
return self._CertInfoCallback
|
|
@@ -1050,9 +1032,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1050
1032
|
|
|
1051
1033
|
@property
|
|
1052
1034
|
def UserDefineSeal(self):
|
|
1053
|
-
r"""
|
|
1054
|
-
<ul><li>**false**: 不能自己定义(默认)</li>
|
|
1055
|
-
<li>**true**: 可以自己定义</li></ul>
|
|
1035
|
+
r"""<p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
|
|
1056
1036
|
:rtype: bool
|
|
1057
1037
|
"""
|
|
1058
1038
|
return self._UserDefineSeal
|
|
@@ -1063,9 +1043,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1063
1043
|
|
|
1064
1044
|
@property
|
|
1065
1045
|
def SealImgCallback(self):
|
|
1066
|
-
r"""
|
|
1067
|
-
<ul><li>**false**: 不需要(默认)</li>
|
|
1068
|
-
<li>**true**: 需要</li></ul>
|
|
1046
|
+
r"""<p>回调中是否需要自动签将要使用的印章(签名)图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
|
|
1069
1047
|
:rtype: bool
|
|
1070
1048
|
"""
|
|
1071
1049
|
return self._SealImgCallback
|
|
@@ -1078,7 +1056,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1078
1056
|
def CallbackUrl(self):
|
|
1079
1057
|
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
|
|
1080
1058
|
|
|
1081
|
-
r"""
|
|
1059
|
+
r"""<p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
|
|
1082
1060
|
:rtype: str
|
|
1083
1061
|
"""
|
|
1084
1062
|
return self._CallbackUrl
|
|
@@ -1091,13 +1069,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1091
1069
|
|
|
1092
1070
|
@property
|
|
1093
1071
|
def VerifyChannels(self):
|
|
1094
|
-
r"""
|
|
1095
|
-
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
|
|
1096
|
-
<li>**INSIGHT** : 慧眼人脸识别</li>
|
|
1097
|
-
<li>**TELECOM** : 运营商三要素验证</li></ul>
|
|
1098
|
-
注:
|
|
1099
|
-
<ul><li>如果是小程序开通链接,仅支持传 WEIXINAPP。为空默认 WEIXINAPP</li>
|
|
1100
|
-
<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
|
|
1072
|
+
r"""<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>
|
|
1101
1073
|
:rtype: list of str
|
|
1102
1074
|
"""
|
|
1103
1075
|
return self._VerifyChannels
|
|
@@ -1108,11 +1080,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1108
1080
|
|
|
1109
1081
|
@property
|
|
1110
1082
|
def LicenseType(self):
|
|
1111
|
-
r"""
|
|
1112
|
-
|
|
1113
|
-
<ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul>
|
|
1114
|
-
|
|
1115
|
-
注:`该字段已经失效,请勿设置此参数。`
|
|
1083
|
+
r"""<p>设置用户开通自动签时是否绑定个人自动签账号许可。</p><ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
|
|
1116
1084
|
:rtype: int
|
|
1117
1085
|
"""
|
|
1118
1086
|
return self._LicenseType
|
|
@@ -1123,16 +1091,7 @@ class AutoSignConfig(AbstractModel):
|
|
|
1123
1091
|
|
|
1124
1092
|
@property
|
|
1125
1093
|
def JumpUrl(self):
|
|
1126
|
-
r"""
|
|
1127
|
-
|
|
1128
|
-
注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
|
|
1129
|
-
|
|
1130
|
-
跳转场景:
|
|
1131
|
-
<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>
|
|
1132
|
-
<li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
|
|
1133
|
-
|
|
1134
|
-
成功结果返回:
|
|
1135
|
-
若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如:qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
|
|
1094
|
+
r"""<p>开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。</p><p>注:<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景:</p><ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生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&result=success&from=tencent_ess</p>
|
|
1136
1095
|
:rtype: str
|
|
1137
1096
|
"""
|
|
1138
1097
|
return self._JumpUrl
|
|
@@ -3755,220 +3714,6 @@ class ChannelCreateBoundFlowsResponse(AbstractModel):
|
|
|
3755
3714
|
self._RequestId = params.get("RequestId")
|
|
3756
3715
|
|
|
3757
3716
|
|
|
3758
|
-
class ChannelCreateConvertTaskApiRequest(AbstractModel):
|
|
3759
|
-
r"""ChannelCreateConvertTaskApi请求参数结构体
|
|
3760
|
-
|
|
3761
|
-
"""
|
|
3762
|
-
|
|
3763
|
-
def __init__(self):
|
|
3764
|
-
r"""
|
|
3765
|
-
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3766
|
-
|
|
3767
|
-
此接口下面信息必填。
|
|
3768
|
-
<ul>
|
|
3769
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
3770
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3771
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3772
|
-
</ul>
|
|
3773
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
3774
|
-
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
3775
|
-
:param _ResourceType: 需要进行转换的资源文件类型
|
|
3776
|
-
支持的文件类型如下:
|
|
3777
|
-
<ul><li>doc</li>
|
|
3778
|
-
<li>docx</li>
|
|
3779
|
-
<li>xls</li>
|
|
3780
|
-
<li>xlsx</li>
|
|
3781
|
-
<li>jpg</li>
|
|
3782
|
-
<li>jpeg</li>
|
|
3783
|
-
<li>png</li>
|
|
3784
|
-
<li>bmp</li>
|
|
3785
|
-
<li>html</li>
|
|
3786
|
-
<li>txt</li></ul>
|
|
3787
|
-
:type ResourceType: str
|
|
3788
|
-
:param _ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
|
|
3789
|
-
|
|
3790
|
-
注: `资源名称长度限制为256个字符`
|
|
3791
|
-
:type ResourceName: str
|
|
3792
|
-
:param _ResourceId: 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
|
|
3793
|
-
|
|
3794
|
-
注: `目前,此接口仅支持单个文件进行转换。`
|
|
3795
|
-
:type ResourceId: str
|
|
3796
|
-
:param _Operator: 调用方用户信息,不用传
|
|
3797
|
-
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
3798
|
-
:param _Organization: 暂未开放
|
|
3799
|
-
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
|
|
3800
|
-
"""
|
|
3801
|
-
self._Agent = None
|
|
3802
|
-
self._ResourceType = None
|
|
3803
|
-
self._ResourceName = None
|
|
3804
|
-
self._ResourceId = None
|
|
3805
|
-
self._Operator = None
|
|
3806
|
-
self._Organization = None
|
|
3807
|
-
|
|
3808
|
-
@property
|
|
3809
|
-
def Agent(self):
|
|
3810
|
-
r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3811
|
-
|
|
3812
|
-
此接口下面信息必填。
|
|
3813
|
-
<ul>
|
|
3814
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
3815
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3816
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3817
|
-
</ul>
|
|
3818
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
3819
|
-
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
3820
|
-
"""
|
|
3821
|
-
return self._Agent
|
|
3822
|
-
|
|
3823
|
-
@Agent.setter
|
|
3824
|
-
def Agent(self, Agent):
|
|
3825
|
-
self._Agent = Agent
|
|
3826
|
-
|
|
3827
|
-
@property
|
|
3828
|
-
def ResourceType(self):
|
|
3829
|
-
r"""需要进行转换的资源文件类型
|
|
3830
|
-
支持的文件类型如下:
|
|
3831
|
-
<ul><li>doc</li>
|
|
3832
|
-
<li>docx</li>
|
|
3833
|
-
<li>xls</li>
|
|
3834
|
-
<li>xlsx</li>
|
|
3835
|
-
<li>jpg</li>
|
|
3836
|
-
<li>jpeg</li>
|
|
3837
|
-
<li>png</li>
|
|
3838
|
-
<li>bmp</li>
|
|
3839
|
-
<li>html</li>
|
|
3840
|
-
<li>txt</li></ul>
|
|
3841
|
-
:rtype: str
|
|
3842
|
-
"""
|
|
3843
|
-
return self._ResourceType
|
|
3844
|
-
|
|
3845
|
-
@ResourceType.setter
|
|
3846
|
-
def ResourceType(self, ResourceType):
|
|
3847
|
-
self._ResourceType = ResourceType
|
|
3848
|
-
|
|
3849
|
-
@property
|
|
3850
|
-
def ResourceName(self):
|
|
3851
|
-
r"""需要进行转换操作的文件资源名称,带资源后缀名。
|
|
3852
|
-
|
|
3853
|
-
注: `资源名称长度限制为256个字符`
|
|
3854
|
-
:rtype: str
|
|
3855
|
-
"""
|
|
3856
|
-
return self._ResourceName
|
|
3857
|
-
|
|
3858
|
-
@ResourceName.setter
|
|
3859
|
-
def ResourceName(self, ResourceName):
|
|
3860
|
-
self._ResourceName = ResourceName
|
|
3861
|
-
|
|
3862
|
-
@property
|
|
3863
|
-
def ResourceId(self):
|
|
3864
|
-
r"""需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
|
|
3865
|
-
|
|
3866
|
-
注: `目前,此接口仅支持单个文件进行转换。`
|
|
3867
|
-
:rtype: str
|
|
3868
|
-
"""
|
|
3869
|
-
return self._ResourceId
|
|
3870
|
-
|
|
3871
|
-
@ResourceId.setter
|
|
3872
|
-
def ResourceId(self, ResourceId):
|
|
3873
|
-
self._ResourceId = ResourceId
|
|
3874
|
-
|
|
3875
|
-
@property
|
|
3876
|
-
def Operator(self):
|
|
3877
|
-
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
|
|
3878
|
-
|
|
3879
|
-
r"""调用方用户信息,不用传
|
|
3880
|
-
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
3881
|
-
"""
|
|
3882
|
-
return self._Operator
|
|
3883
|
-
|
|
3884
|
-
@Operator.setter
|
|
3885
|
-
def Operator(self, Operator):
|
|
3886
|
-
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
|
|
3887
|
-
|
|
3888
|
-
self._Operator = Operator
|
|
3889
|
-
|
|
3890
|
-
@property
|
|
3891
|
-
def Organization(self):
|
|
3892
|
-
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
|
|
3893
|
-
|
|
3894
|
-
r"""暂未开放
|
|
3895
|
-
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
|
|
3896
|
-
"""
|
|
3897
|
-
return self._Organization
|
|
3898
|
-
|
|
3899
|
-
@Organization.setter
|
|
3900
|
-
def Organization(self, Organization):
|
|
3901
|
-
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
|
|
3902
|
-
|
|
3903
|
-
self._Organization = Organization
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
def _deserialize(self, params):
|
|
3907
|
-
if params.get("Agent") is not None:
|
|
3908
|
-
self._Agent = Agent()
|
|
3909
|
-
self._Agent._deserialize(params.get("Agent"))
|
|
3910
|
-
self._ResourceType = params.get("ResourceType")
|
|
3911
|
-
self._ResourceName = params.get("ResourceName")
|
|
3912
|
-
self._ResourceId = params.get("ResourceId")
|
|
3913
|
-
if params.get("Operator") is not None:
|
|
3914
|
-
self._Operator = UserInfo()
|
|
3915
|
-
self._Operator._deserialize(params.get("Operator"))
|
|
3916
|
-
if params.get("Organization") is not None:
|
|
3917
|
-
self._Organization = OrganizationInfo()
|
|
3918
|
-
self._Organization._deserialize(params.get("Organization"))
|
|
3919
|
-
memeber_set = set(params.keys())
|
|
3920
|
-
for name, value in vars(self).items():
|
|
3921
|
-
property_name = name[1:]
|
|
3922
|
-
if property_name in memeber_set:
|
|
3923
|
-
memeber_set.remove(property_name)
|
|
3924
|
-
if len(memeber_set) > 0:
|
|
3925
|
-
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
class ChannelCreateConvertTaskApiResponse(AbstractModel):
|
|
3930
|
-
r"""ChannelCreateConvertTaskApi返回参数结构体
|
|
3931
|
-
|
|
3932
|
-
"""
|
|
3933
|
-
|
|
3934
|
-
def __init__(self):
|
|
3935
|
-
r"""
|
|
3936
|
-
:param _TaskId: 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
|
|
3937
|
-
:type TaskId: str
|
|
3938
|
-
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3939
|
-
:type RequestId: str
|
|
3940
|
-
"""
|
|
3941
|
-
self._TaskId = None
|
|
3942
|
-
self._RequestId = None
|
|
3943
|
-
|
|
3944
|
-
@property
|
|
3945
|
-
def TaskId(self):
|
|
3946
|
-
r"""接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
|
|
3947
|
-
:rtype: str
|
|
3948
|
-
"""
|
|
3949
|
-
return self._TaskId
|
|
3950
|
-
|
|
3951
|
-
@TaskId.setter
|
|
3952
|
-
def TaskId(self, TaskId):
|
|
3953
|
-
self._TaskId = TaskId
|
|
3954
|
-
|
|
3955
|
-
@property
|
|
3956
|
-
def RequestId(self):
|
|
3957
|
-
r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3958
|
-
:rtype: str
|
|
3959
|
-
"""
|
|
3960
|
-
return self._RequestId
|
|
3961
|
-
|
|
3962
|
-
@RequestId.setter
|
|
3963
|
-
def RequestId(self, RequestId):
|
|
3964
|
-
self._RequestId = RequestId
|
|
3965
|
-
|
|
3966
|
-
|
|
3967
|
-
def _deserialize(self, params):
|
|
3968
|
-
self._TaskId = params.get("TaskId")
|
|
3969
|
-
self._RequestId = params.get("RequestId")
|
|
3970
|
-
|
|
3971
|
-
|
|
3972
3717
|
class ChannelCreateDynamicFlowApproverRequest(AbstractModel):
|
|
3973
3718
|
r"""ChannelCreateDynamicFlowApprover请求参数结构体
|
|
3974
3719
|
|
|
@@ -4088,7 +3833,7 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
|
|
|
4088
3833
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
4089
3834
|
:param _EmbedType: <p>要生成WEB嵌入界面的类型, 可以选择的值如下: </p><ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li><li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li><li>MODIFY_TEMPLATE:生成修改模板的嵌入页面</li><li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li><li>PREVIEW_FLOW:生成预览合同文档的嵌入页面(H5链接,支持移动端的浏览器中打开)</li><li>PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面(仅支持PC的浏览器中打开)</li><li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li><li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li><li>EXTEND_SERVICE:生成扩展服务的嵌入页面</li></ul>
|
|
4090
3835
|
:type EmbedType: str
|
|
4091
|
-
:param _BusinessId: <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li><li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
3836
|
+
:param _BusinessId: <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li><li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a> 来进行转换成PDF资源。</li></ol>
|
|
4092
3837
|
:type BusinessId: str
|
|
4093
3838
|
:param _HiddenComponents: <p>是否隐藏控件,只有预览模板时生效,目前字段已废弃,请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes#embedurloption">嵌入式页面url个性化参数Option</a> 的ShowTemplateComponent来指定是否展示or隐藏控件</p>
|
|
4094
3839
|
:type HiddenComponents: bool
|
|
@@ -4131,7 +3876,7 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
|
|
|
4131
3876
|
|
|
4132
3877
|
@property
|
|
4133
3878
|
def BusinessId(self):
|
|
4134
|
-
r"""<p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li><li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
3879
|
+
r"""<p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为MODIFY_TEMPLATE,PREVIEW_TEMPLATE必填,取值为模板id</li><li>为CREATE_TEMPLATE,非必填,取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)*</li><li>为PREVIEW_FLOW,PREVIEW_FLOW_DETAIL必填,取值为合同id</li><li>为PREVIEW_SEAL_DETAIL必填,取值为印章id</li></ul><p>注意:</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型, 如果您的文件不是PDF, 请使用接口<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a> 来进行转换成PDF资源。</li></ol>
|
|
4135
3880
|
:rtype: str
|
|
4136
3881
|
"""
|
|
4137
3882
|
return self._BusinessId
|
|
@@ -5218,20 +4963,11 @@ class ChannelCreateFlowGroupByTemplatesRequest(AbstractModel):
|
|
|
5218
4963
|
|
|
5219
4964
|
def __init__(self):
|
|
5220
4965
|
r"""
|
|
5221
|
-
:param _Agent:
|
|
5222
|
-
|
|
5223
|
-
此接口下面信息必填。
|
|
5224
|
-
<ul>
|
|
5225
|
-
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
|
|
5226
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li>
|
|
5227
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li>
|
|
5228
|
-
</ul>
|
|
5229
|
-
|
|
5230
|
-
合同的发起企业和发起人必需已经完成实名,并加入企业
|
|
4966
|
+
:param _Agent: <p>合同的发起企业和发起人信息,<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a></p><p>此接口下面信息必填。</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><p>合同的发起企业和发起人必需已经完成实名,并加入企业</p>
|
|
5231
4967
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
5232
|
-
:param _FlowInfos:
|
|
4968
|
+
:param _FlowInfos: <p>合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。</p>
|
|
5233
4969
|
:type FlowInfos: list of FlowInfo
|
|
5234
|
-
:param _FlowGroupName:
|
|
4970
|
+
:param _FlowGroupName: <p>合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
|
|
5235
4971
|
:type FlowGroupName: str
|
|
5236
4972
|
"""
|
|
5237
4973
|
self._Agent = None
|
|
@@ -5240,16 +4976,7 @@ class ChannelCreateFlowGroupByTemplatesRequest(AbstractModel):
|
|
|
5240
4976
|
|
|
5241
4977
|
@property
|
|
5242
4978
|
def Agent(self):
|
|
5243
|
-
r"""
|
|
5244
|
-
|
|
5245
|
-
此接口下面信息必填。
|
|
5246
|
-
<ul>
|
|
5247
|
-
<li>渠道应用标识: <a href="https://qcloudimg.tencent-cloud.cn/raw/a71872de3d540d55451e3e73a2ad1a6e.png" target="_blank">Agent.AppId</a></li>
|
|
5248
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId(合同的发起企业)</li>
|
|
5249
|
-
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId (合同的发起人)</li>
|
|
5250
|
-
</ul>
|
|
5251
|
-
|
|
5252
|
-
合同的发起企业和发起人必需已经完成实名,并加入企业
|
|
4979
|
+
r"""<p>合同的发起企业和发起人信息,<a href="https://qcloudimg.tencent-cloud.cn/raw/b69f8aad306c40b7b78d096e39b2edbb.png" target="_blank">点击查看合同发起企业和人展示的位置</a></p><p>此接口下面信息必填。</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><p>合同的发起企业和发起人必需已经完成实名,并加入企业</p>
|
|
5253
4980
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
5254
4981
|
"""
|
|
5255
4982
|
return self._Agent
|
|
@@ -5260,7 +4987,7 @@ class ChannelCreateFlowGroupByTemplatesRequest(AbstractModel):
|
|
|
5260
4987
|
|
|
5261
4988
|
@property
|
|
5262
4989
|
def FlowInfos(self):
|
|
5263
|
-
r"""
|
|
4990
|
+
r"""<p>合同组中每个合同签署流程的信息,合同组中最少包含2个合同,不能超过50个合同。</p>
|
|
5264
4991
|
:rtype: list of FlowInfo
|
|
5265
4992
|
"""
|
|
5266
4993
|
return self._FlowInfos
|
|
@@ -5271,7 +4998,7 @@ class ChannelCreateFlowGroupByTemplatesRequest(AbstractModel):
|
|
|
5271
4998
|
|
|
5272
4999
|
@property
|
|
5273
5000
|
def FlowGroupName(self):
|
|
5274
|
-
r"""
|
|
5001
|
+
r"""<p>合同组的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。</p>
|
|
5275
5002
|
:rtype: str
|
|
5276
5003
|
"""
|
|
5277
5004
|
return self._FlowGroupName
|
|
@@ -5309,18 +5036,13 @@ class ChannelCreateFlowGroupByTemplatesResponse(AbstractModel):
|
|
|
5309
5036
|
|
|
5310
5037
|
def __init__(self):
|
|
5311
5038
|
r"""
|
|
5312
|
-
:param _FlowGroupId:
|
|
5313
|
-
建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
|
|
5039
|
+
:param _FlowGroupId: <p>合同组ID,为32位字符串。<br>建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。</p>
|
|
5314
5040
|
:type FlowGroupId: str
|
|
5315
|
-
:param _FlowIds:
|
|
5316
|
-
|
|
5317
|
-
注:
|
|
5318
|
-
`此数组的顺序和入参中的FlowInfos顺序一致`
|
|
5041
|
+
:param _FlowIds: <p>合同组中每个合同流程ID,每个ID均为32位字符串。</p><p>注:<br><code>此数组的顺序和入参中的FlowInfos顺序一致</code></p>
|
|
5319
5042
|
:type FlowIds: list of str
|
|
5320
|
-
:param _TaskInfos:
|
|
5321
|
-
如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
|
|
5043
|
+
:param _TaskInfos: <p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br>如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询任务详情;</p>
|
|
5322
5044
|
:type TaskInfos: list of TaskInfo
|
|
5323
|
-
:param _Approvers:
|
|
5045
|
+
:param _Approvers: <p>合同组签署方信息</p>
|
|
5324
5046
|
:type Approvers: list of FlowGroupApprovers
|
|
5325
5047
|
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
5326
5048
|
:type RequestId: str
|
|
@@ -5333,8 +5055,7 @@ class ChannelCreateFlowGroupByTemplatesResponse(AbstractModel):
|
|
|
5333
5055
|
|
|
5334
5056
|
@property
|
|
5335
5057
|
def FlowGroupId(self):
|
|
5336
|
-
r"""
|
|
5337
|
-
建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。
|
|
5058
|
+
r"""<p>合同组ID,为32位字符串。<br>建议开发者妥善保存此合同组ID,以便于顺利进行后续操作。</p>
|
|
5338
5059
|
:rtype: str
|
|
5339
5060
|
"""
|
|
5340
5061
|
return self._FlowGroupId
|
|
@@ -5345,10 +5066,7 @@ class ChannelCreateFlowGroupByTemplatesResponse(AbstractModel):
|
|
|
5345
5066
|
|
|
5346
5067
|
@property
|
|
5347
5068
|
def FlowIds(self):
|
|
5348
|
-
r"""
|
|
5349
|
-
|
|
5350
|
-
注:
|
|
5351
|
-
`此数组的顺序和入参中的FlowInfos顺序一致`
|
|
5069
|
+
r"""<p>合同组中每个合同流程ID,每个ID均为32位字符串。</p><p>注:<br><code>此数组的顺序和入参中的FlowInfos顺序一致</code></p>
|
|
5352
5070
|
:rtype: list of str
|
|
5353
5071
|
"""
|
|
5354
5072
|
return self._FlowIds
|
|
@@ -5359,8 +5077,7 @@ class ChannelCreateFlowGroupByTemplatesResponse(AbstractModel):
|
|
|
5359
5077
|
|
|
5360
5078
|
@property
|
|
5361
5079
|
def TaskInfos(self):
|
|
5362
|
-
r"""
|
|
5363
|
-
如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
|
|
5080
|
+
r"""<p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br>如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询任务详情;</p>
|
|
5364
5081
|
:rtype: list of TaskInfo
|
|
5365
5082
|
"""
|
|
5366
5083
|
return self._TaskInfos
|
|
@@ -5371,7 +5088,7 @@ class ChannelCreateFlowGroupByTemplatesResponse(AbstractModel):
|
|
|
5371
5088
|
|
|
5372
5089
|
@property
|
|
5373
5090
|
def Approvers(self):
|
|
5374
|
-
r"""
|
|
5091
|
+
r"""<p>合同组签署方信息</p>
|
|
5375
5092
|
:rtype: list of FlowGroupApprovers
|
|
5376
5093
|
"""
|
|
5377
5094
|
return self._Approvers
|
|
@@ -5723,7 +5440,7 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
|
|
|
5723
5440
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
5724
5441
|
:param _FlowId: <p>合同流程ID,为32位字符串。<br>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。<br>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</p>
|
|
5725
5442
|
:type FlowId: str
|
|
5726
|
-
:param _FlowApproverInfos: <p>流程签署人列表,其中结构体的ApproverType必传。<br>若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。<br>若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)</p><p>此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p
|
|
5443
|
+
:param _FlowApproverInfos: <p>流程签署人列表,其中结构体的ApproverType必传。<br>若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。<br>若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)</p><p>此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p>注:</p><ol><li>签署人<b>只能使用签名类型、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。</li><li>对于签名控件类型,支持手写签名、系统签名、个人印章等类型的签名方式,取决于合同发起时的设定。另外,签署的时候不支持拉取个人签署方已有签名图片资产,且创建的签名图片为一次性使用,不会保存为签署方个人资产。</li><li>生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。</li></ol>
|
|
5727
5444
|
:type FlowApproverInfos: list of FlowApproverInfo
|
|
5728
5445
|
:param _VideoVerifyTimesLimit: <p>用于指定进入视频签署的限制次数,次数取值范围:1 - 10,不设置则默认为5次,仅视频签署时生效。</p>
|
|
5729
5446
|
:type VideoVerifyTimesLimit: int
|
|
@@ -5772,7 +5489,7 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
|
|
|
5772
5489
|
|
|
5773
5490
|
@property
|
|
5774
5491
|
def FlowApproverInfos(self):
|
|
5775
|
-
r"""<p>流程签署人列表,其中结构体的ApproverType必传。<br>若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。<br>若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)</p><p>此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p
|
|
5492
|
+
r"""<p>流程签署人列表,其中结构体的ApproverType必传。<br>若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。<br>若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)</p><p>此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p>注:</p><ol><li>签署人<b>只能使用签名类型、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。</li><li>对于签名控件类型,支持手写签名、系统签名、个人印章等类型的签名方式,取决于合同发起时的设定。另外,签署的时候不支持拉取个人签署方已有签名图片资产,且创建的签名图片为一次性使用,不会保存为签署方个人资产。</li><li>生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。</li></ol>
|
|
5776
5493
|
:rtype: list of FlowApproverInfo
|
|
5777
5494
|
"""
|
|
5778
5495
|
return self._FlowApproverInfos
|
|
@@ -10895,250 +10612,6 @@ class ChannelDisableUserAutoSignResponse(AbstractModel):
|
|
|
10895
10612
|
self._RequestId = params.get("RequestId")
|
|
10896
10613
|
|
|
10897
10614
|
|
|
10898
|
-
class ChannelGetTaskResultApiRequest(AbstractModel):
|
|
10899
|
-
r"""ChannelGetTaskResultApi请求参数结构体
|
|
10900
|
-
|
|
10901
|
-
"""
|
|
10902
|
-
|
|
10903
|
-
def __init__(self):
|
|
10904
|
-
r"""
|
|
10905
|
-
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
10906
|
-
|
|
10907
|
-
此接口下面信息必填。
|
|
10908
|
-
<ul>
|
|
10909
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
10910
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
10911
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
10912
|
-
</ul>
|
|
10913
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
10914
|
-
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
10915
|
-
:param _TaskId: 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
|
|
10916
|
-
:type TaskId: str
|
|
10917
|
-
:param _Operator: 操作者的信息,不用传
|
|
10918
|
-
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
10919
|
-
:param _Organization: 暂未开放
|
|
10920
|
-
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
|
|
10921
|
-
"""
|
|
10922
|
-
self._Agent = None
|
|
10923
|
-
self._TaskId = None
|
|
10924
|
-
self._Operator = None
|
|
10925
|
-
self._Organization = None
|
|
10926
|
-
|
|
10927
|
-
@property
|
|
10928
|
-
def Agent(self):
|
|
10929
|
-
r"""关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
10930
|
-
|
|
10931
|
-
此接口下面信息必填。
|
|
10932
|
-
<ul>
|
|
10933
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
10934
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
10935
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
10936
|
-
</ul>
|
|
10937
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
10938
|
-
:rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
10939
|
-
"""
|
|
10940
|
-
return self._Agent
|
|
10941
|
-
|
|
10942
|
-
@Agent.setter
|
|
10943
|
-
def Agent(self, Agent):
|
|
10944
|
-
self._Agent = Agent
|
|
10945
|
-
|
|
10946
|
-
@property
|
|
10947
|
-
def TaskId(self):
|
|
10948
|
-
r"""转换任务Id,通过接口<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>得到的转换任务id
|
|
10949
|
-
:rtype: str
|
|
10950
|
-
"""
|
|
10951
|
-
return self._TaskId
|
|
10952
|
-
|
|
10953
|
-
@TaskId.setter
|
|
10954
|
-
def TaskId(self, TaskId):
|
|
10955
|
-
self._TaskId = TaskId
|
|
10956
|
-
|
|
10957
|
-
@property
|
|
10958
|
-
def Operator(self):
|
|
10959
|
-
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
|
|
10960
|
-
|
|
10961
|
-
r"""操作者的信息,不用传
|
|
10962
|
-
:rtype: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
10963
|
-
"""
|
|
10964
|
-
return self._Operator
|
|
10965
|
-
|
|
10966
|
-
@Operator.setter
|
|
10967
|
-
def Operator(self, Operator):
|
|
10968
|
-
warnings.warn("parameter `Operator` is deprecated", DeprecationWarning)
|
|
10969
|
-
|
|
10970
|
-
self._Operator = Operator
|
|
10971
|
-
|
|
10972
|
-
@property
|
|
10973
|
-
def Organization(self):
|
|
10974
|
-
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
|
|
10975
|
-
|
|
10976
|
-
r"""暂未开放
|
|
10977
|
-
:rtype: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
|
|
10978
|
-
"""
|
|
10979
|
-
return self._Organization
|
|
10980
|
-
|
|
10981
|
-
@Organization.setter
|
|
10982
|
-
def Organization(self, Organization):
|
|
10983
|
-
warnings.warn("parameter `Organization` is deprecated", DeprecationWarning)
|
|
10984
|
-
|
|
10985
|
-
self._Organization = Organization
|
|
10986
|
-
|
|
10987
|
-
|
|
10988
|
-
def _deserialize(self, params):
|
|
10989
|
-
if params.get("Agent") is not None:
|
|
10990
|
-
self._Agent = Agent()
|
|
10991
|
-
self._Agent._deserialize(params.get("Agent"))
|
|
10992
|
-
self._TaskId = params.get("TaskId")
|
|
10993
|
-
if params.get("Operator") is not None:
|
|
10994
|
-
self._Operator = UserInfo()
|
|
10995
|
-
self._Operator._deserialize(params.get("Operator"))
|
|
10996
|
-
if params.get("Organization") is not None:
|
|
10997
|
-
self._Organization = OrganizationInfo()
|
|
10998
|
-
self._Organization._deserialize(params.get("Organization"))
|
|
10999
|
-
memeber_set = set(params.keys())
|
|
11000
|
-
for name, value in vars(self).items():
|
|
11001
|
-
property_name = name[1:]
|
|
11002
|
-
if property_name in memeber_set:
|
|
11003
|
-
memeber_set.remove(property_name)
|
|
11004
|
-
if len(memeber_set) > 0:
|
|
11005
|
-
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
11006
|
-
|
|
11007
|
-
|
|
11008
|
-
|
|
11009
|
-
class ChannelGetTaskResultApiResponse(AbstractModel):
|
|
11010
|
-
r"""ChannelGetTaskResultApi返回参数结构体
|
|
11011
|
-
|
|
11012
|
-
"""
|
|
11013
|
-
|
|
11014
|
-
def __init__(self):
|
|
11015
|
-
r"""
|
|
11016
|
-
:param _TaskId: 任务Id
|
|
11017
|
-
:type TaskId: str
|
|
11018
|
-
:param _TaskStatus: 任务状态,需要关注的状态
|
|
11019
|
-
<ul><li>**0** :NeedTranform - 任务已提交</li>
|
|
11020
|
-
<li>**4** :Processing - 文档转换中</li>
|
|
11021
|
-
<li>**8** :TaskEnd - 任务处理完成</li>
|
|
11022
|
-
<li>**-2** :DownloadFailed - 下载失败</li>
|
|
11023
|
-
<li>**-6** :ProcessFailed - 转换失败</li>
|
|
11024
|
-
<li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
|
|
11025
|
-
:type TaskStatus: int
|
|
11026
|
-
:param _TaskMessage: 状态描述,需要关注的状态
|
|
11027
|
-
<ul><li> **NeedTranform** : 任务已提交</li>
|
|
11028
|
-
<li> **Processing** : 文档转换中</li>
|
|
11029
|
-
<li> **TaskEnd** : 任务处理完成</li>
|
|
11030
|
-
<li> **DownloadFailed** : 下载失败</li>
|
|
11031
|
-
<li> **ProcessFailed** : 转换失败</li>
|
|
11032
|
-
<li> **ProcessTimeout** : 转换文件超时</li></ul>
|
|
11033
|
-
:type TaskMessage: str
|
|
11034
|
-
:param _ResourceId: 资源Id(即FileId),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)
|
|
11035
|
-
:type ResourceId: str
|
|
11036
|
-
:param _PreviewUrl: 预览文件Url,有效期30分钟
|
|
11037
|
-
当前字段返回为空,发起的时候,将ResourceId 放入发起即可
|
|
11038
|
-
:type PreviewUrl: str
|
|
11039
|
-
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
11040
|
-
:type RequestId: str
|
|
11041
|
-
"""
|
|
11042
|
-
self._TaskId = None
|
|
11043
|
-
self._TaskStatus = None
|
|
11044
|
-
self._TaskMessage = None
|
|
11045
|
-
self._ResourceId = None
|
|
11046
|
-
self._PreviewUrl = None
|
|
11047
|
-
self._RequestId = None
|
|
11048
|
-
|
|
11049
|
-
@property
|
|
11050
|
-
def TaskId(self):
|
|
11051
|
-
r"""任务Id
|
|
11052
|
-
:rtype: str
|
|
11053
|
-
"""
|
|
11054
|
-
return self._TaskId
|
|
11055
|
-
|
|
11056
|
-
@TaskId.setter
|
|
11057
|
-
def TaskId(self, TaskId):
|
|
11058
|
-
self._TaskId = TaskId
|
|
11059
|
-
|
|
11060
|
-
@property
|
|
11061
|
-
def TaskStatus(self):
|
|
11062
|
-
r"""任务状态,需要关注的状态
|
|
11063
|
-
<ul><li>**0** :NeedTranform - 任务已提交</li>
|
|
11064
|
-
<li>**4** :Processing - 文档转换中</li>
|
|
11065
|
-
<li>**8** :TaskEnd - 任务处理完成</li>
|
|
11066
|
-
<li>**-2** :DownloadFailed - 下载失败</li>
|
|
11067
|
-
<li>**-6** :ProcessFailed - 转换失败</li>
|
|
11068
|
-
<li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
|
|
11069
|
-
:rtype: int
|
|
11070
|
-
"""
|
|
11071
|
-
return self._TaskStatus
|
|
11072
|
-
|
|
11073
|
-
@TaskStatus.setter
|
|
11074
|
-
def TaskStatus(self, TaskStatus):
|
|
11075
|
-
self._TaskStatus = TaskStatus
|
|
11076
|
-
|
|
11077
|
-
@property
|
|
11078
|
-
def TaskMessage(self):
|
|
11079
|
-
r"""状态描述,需要关注的状态
|
|
11080
|
-
<ul><li> **NeedTranform** : 任务已提交</li>
|
|
11081
|
-
<li> **Processing** : 文档转换中</li>
|
|
11082
|
-
<li> **TaskEnd** : 任务处理完成</li>
|
|
11083
|
-
<li> **DownloadFailed** : 下载失败</li>
|
|
11084
|
-
<li> **ProcessFailed** : 转换失败</li>
|
|
11085
|
-
<li> **ProcessTimeout** : 转换文件超时</li></ul>
|
|
11086
|
-
:rtype: str
|
|
11087
|
-
"""
|
|
11088
|
-
return self._TaskMessage
|
|
11089
|
-
|
|
11090
|
-
@TaskMessage.setter
|
|
11091
|
-
def TaskMessage(self, TaskMessage):
|
|
11092
|
-
self._TaskMessage = TaskMessage
|
|
11093
|
-
|
|
11094
|
-
@property
|
|
11095
|
-
def ResourceId(self):
|
|
11096
|
-
r"""资源Id(即FileId),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)
|
|
11097
|
-
:rtype: str
|
|
11098
|
-
"""
|
|
11099
|
-
return self._ResourceId
|
|
11100
|
-
|
|
11101
|
-
@ResourceId.setter
|
|
11102
|
-
def ResourceId(self, ResourceId):
|
|
11103
|
-
self._ResourceId = ResourceId
|
|
11104
|
-
|
|
11105
|
-
@property
|
|
11106
|
-
def PreviewUrl(self):
|
|
11107
|
-
warnings.warn("parameter `PreviewUrl` is deprecated", DeprecationWarning)
|
|
11108
|
-
|
|
11109
|
-
r"""预览文件Url,有效期30分钟
|
|
11110
|
-
当前字段返回为空,发起的时候,将ResourceId 放入发起即可
|
|
11111
|
-
:rtype: str
|
|
11112
|
-
"""
|
|
11113
|
-
return self._PreviewUrl
|
|
11114
|
-
|
|
11115
|
-
@PreviewUrl.setter
|
|
11116
|
-
def PreviewUrl(self, PreviewUrl):
|
|
11117
|
-
warnings.warn("parameter `PreviewUrl` is deprecated", DeprecationWarning)
|
|
11118
|
-
|
|
11119
|
-
self._PreviewUrl = PreviewUrl
|
|
11120
|
-
|
|
11121
|
-
@property
|
|
11122
|
-
def RequestId(self):
|
|
11123
|
-
r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
11124
|
-
:rtype: str
|
|
11125
|
-
"""
|
|
11126
|
-
return self._RequestId
|
|
11127
|
-
|
|
11128
|
-
@RequestId.setter
|
|
11129
|
-
def RequestId(self, RequestId):
|
|
11130
|
-
self._RequestId = RequestId
|
|
11131
|
-
|
|
11132
|
-
|
|
11133
|
-
def _deserialize(self, params):
|
|
11134
|
-
self._TaskId = params.get("TaskId")
|
|
11135
|
-
self._TaskStatus = params.get("TaskStatus")
|
|
11136
|
-
self._TaskMessage = params.get("TaskMessage")
|
|
11137
|
-
self._ResourceId = params.get("ResourceId")
|
|
11138
|
-
self._PreviewUrl = params.get("PreviewUrl")
|
|
11139
|
-
self._RequestId = params.get("RequestId")
|
|
11140
|
-
|
|
11141
|
-
|
|
11142
10615
|
class ChannelModifyRoleRequest(AbstractModel):
|
|
11143
10616
|
r"""ChannelModifyRole请求参数结构体
|
|
11144
10617
|
|
|
@@ -16286,7 +15759,7 @@ class CreateFlowsByTemplatesRequest(AbstractModel):
|
|
|
16286
15759
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
16287
15760
|
:param _FlowInfos: <p>要创建的合同信息列表,最多支持一次创建20个合同</p>
|
|
16288
15761
|
:type FlowInfos: list of FlowInfo
|
|
16289
|
-
:param _NeedPreview: <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul><p><strong>注1</strong>: 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId
|
|
15762
|
+
:param _NeedPreview: <p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul><p><strong>注1</strong>: 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询得到</p><p><strong>注2</strong>: 预览服务按照合同份额 1:2的比例赠送预览次数。例如:购买 100 份合同,将赠送 200 次合同预览额度。当赠送的预览额度使用完后,如需继续使用预览服务,则需要单独购买预览服务额度。</p>
|
|
16290
15763
|
:type NeedPreview: bool
|
|
16291
15764
|
:param _PreviewType: <p>预览模式下产生的预览链接类型 </p><ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li><li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>注: <code>此参数在NeedPreview 为true时有效</code>
|
|
16292
15765
|
:type PreviewType: int
|
|
@@ -16323,7 +15796,7 @@ class CreateFlowsByTemplatesRequest(AbstractModel):
|
|
|
16323
15796
|
|
|
16324
15797
|
@property
|
|
16325
15798
|
def NeedPreview(self):
|
|
16326
|
-
r"""<p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul><p><strong>注1</strong>: 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId
|
|
15799
|
+
r"""<p>是否为预览模式,取值如下:</p><ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li><li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。 <font color="red">注意: 以预览模式创建的合同仅供查看,因此参与方无法进行签署操作</font></li></ul><p><strong>注1</strong>: 如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询得到</p><p><strong>注2</strong>: 预览服务按照合同份额 1:2的比例赠送预览次数。例如:购买 100 份合同,将赠送 200 次合同预览额度。当赠送的预览额度使用完后,如需继续使用预览服务,则需要单独购买预览服务额度。</p>
|
|
16327
15800
|
:rtype: bool
|
|
16328
15801
|
"""
|
|
16329
15802
|
return self._NeedPreview
|
|
@@ -16397,9 +15870,9 @@ class CreateFlowsByTemplatesResponse(AbstractModel):
|
|
|
16397
15870
|
:type CustomerData: list of str
|
|
16398
15871
|
:param _ErrorMessages: <p>创建消息,对应多个合同ID,<br>成功为“”,创建失败则对应失败消息</p>
|
|
16399
15872
|
:type ErrorMessages: list of str
|
|
16400
|
-
:param _PreviewUrls: <p>合同预览链接URL数组。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL<br>如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83">合同文档合成完成回调</a>获取或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
15873
|
+
:param _PreviewUrls: <p>合同预览链接URL数组。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL<br>如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83">合同文档合成完成回调</a>获取或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询得到</p>
|
|
16401
15874
|
:type PreviewUrls: list of str
|
|
16402
|
-
:param _TaskInfos: <p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br
|
|
15875
|
+
:param _TaskInfos: <p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br>如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询任务详情;</p>
|
|
16403
15876
|
:type TaskInfos: list of TaskInfo
|
|
16404
15877
|
:param _FlowApprovers: <p>签署方信息,如角色ID、角色名称等</p>
|
|
16405
15878
|
:type FlowApprovers: list of FlowApproverItem
|
|
@@ -16449,7 +15922,7 @@ class CreateFlowsByTemplatesResponse(AbstractModel):
|
|
|
16449
15922
|
|
|
16450
15923
|
@property
|
|
16451
15924
|
def PreviewUrls(self):
|
|
16452
|
-
r"""<p>合同预览链接URL数组。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL<br>如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83">合同文档合成完成回调</a>获取或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/
|
|
15925
|
+
r"""<p>合同预览链接URL数组。</p><p>注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL<br>如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E5%8D%81%E4%B8%80-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83">合同文档合成完成回调</a>获取或使用返回的TaskInfo中的TaskId通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询得到</p>
|
|
16453
15926
|
:rtype: list of str
|
|
16454
15927
|
"""
|
|
16455
15928
|
return self._PreviewUrls
|
|
@@ -16460,7 +15933,7 @@ class CreateFlowsByTemplatesResponse(AbstractModel):
|
|
|
16460
15933
|
|
|
16461
15934
|
@property
|
|
16462
15935
|
def TaskInfos(self):
|
|
16463
|
-
r"""<p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br
|
|
15936
|
+
r"""<p>复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;<br>如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask">查询转换任务状态</a>接口查询任务详情;</p>
|
|
16464
15937
|
:rtype: list of TaskInfo
|
|
16465
15938
|
"""
|
|
16466
15939
|
return self._TaskInfos
|
|
@@ -29877,22 +29350,17 @@ class SignComponentConfig(AbstractModel):
|
|
|
29877
29350
|
|
|
29878
29351
|
def __init__(self):
|
|
29879
29352
|
r"""
|
|
29880
|
-
:param _HideDate:
|
|
29881
|
-
|
|
29882
|
-
- false 展示签署日期(默认)
|
|
29883
|
-
- true 不展示签署日期
|
|
29884
|
-
。
|
|
29353
|
+
:param _HideDate: <p>签署控件默认属性配置,是否默认展示签署日期, 在页面中可以进行修改。</p><ul><li>false 展示签署日期(默认)</li><li>true 不展示签署日期<br><img src="https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png" alt="image">。</li></ul>
|
|
29885
29354
|
:type HideDate: bool
|
|
29355
|
+
:param _AddSignComponentUseSealSize: <p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件(SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL)时,「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值:</p><ul><li>0: 默认关闭,可开启。与现网一致</li><li>1: 关闭且置灰——按控件默认的4.2cm尺寸盖章,签署方无法开启开关</li><li>2: 默认开启且可修改——默认按印章实际尺寸盖章,签署方可手动关闭</li><li>3: 开启且置灰——强制按印章实际尺寸盖章,签署方不可修改</li></ul><p>默认值:0</p>
|
|
29356
|
+
:type AddSignComponentUseSealSize: int
|
|
29886
29357
|
"""
|
|
29887
29358
|
self._HideDate = None
|
|
29359
|
+
self._AddSignComponentUseSealSize = None
|
|
29888
29360
|
|
|
29889
29361
|
@property
|
|
29890
29362
|
def HideDate(self):
|
|
29891
|
-
r"""
|
|
29892
|
-
|
|
29893
|
-
- false 展示签署日期(默认)
|
|
29894
|
-
- true 不展示签署日期
|
|
29895
|
-
。
|
|
29363
|
+
r"""<p>签署控件默认属性配置,是否默认展示签署日期, 在页面中可以进行修改。</p><ul><li>false 展示签署日期(默认)</li><li>true 不展示签署日期<br><img src="https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png" alt="image">。</li></ul>
|
|
29896
29364
|
:rtype: bool
|
|
29897
29365
|
"""
|
|
29898
29366
|
return self._HideDate
|
|
@@ -29901,9 +29369,21 @@ class SignComponentConfig(AbstractModel):
|
|
|
29901
29369
|
def HideDate(self, HideDate):
|
|
29902
29370
|
self._HideDate = HideDate
|
|
29903
29371
|
|
|
29372
|
+
@property
|
|
29373
|
+
def AddSignComponentUseSealSize(self):
|
|
29374
|
+
r"""<p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件(SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL)时,「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值:</p><ul><li>0: 默认关闭,可开启。与现网一致</li><li>1: 关闭且置灰——按控件默认的4.2cm尺寸盖章,签署方无法开启开关</li><li>2: 默认开启且可修改——默认按印章实际尺寸盖章,签署方可手动关闭</li><li>3: 开启且置灰——强制按印章实际尺寸盖章,签署方不可修改</li></ul><p>默认值:0</p>
|
|
29375
|
+
:rtype: int
|
|
29376
|
+
"""
|
|
29377
|
+
return self._AddSignComponentUseSealSize
|
|
29378
|
+
|
|
29379
|
+
@AddSignComponentUseSealSize.setter
|
|
29380
|
+
def AddSignComponentUseSealSize(self, AddSignComponentUseSealSize):
|
|
29381
|
+
self._AddSignComponentUseSealSize = AddSignComponentUseSealSize
|
|
29382
|
+
|
|
29904
29383
|
|
|
29905
29384
|
def _deserialize(self, params):
|
|
29906
29385
|
self._HideDate = params.get("HideDate")
|
|
29386
|
+
self._AddSignComponentUseSealSize = params.get("AddSignComponentUseSealSize")
|
|
29907
29387
|
memeber_set = set(params.keys())
|
|
29908
29388
|
for name, value in vars(self).items():
|
|
29909
29389
|
property_name = name[1:]
|
|
@@ -31550,7 +31030,7 @@ class UploadFilesRequest(AbstractModel):
|
|
|
31550
31030
|
r"""
|
|
31551
31031
|
:param _Agent: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
|
|
31552
31032
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
31553
|
-
:param _BusinessType: <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/
|
|
31033
|
+
:param _BusinessType: <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同,直接上传后使用返回的文件资源Id即可</li><li>SEAL: 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE: 此文件用于归档文件夹,文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE: 此文件用于上传营业执照,用于后续<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>认证子客的时候提供营业执照,文件类型支持.jpg/.jpeg/.png,限制8M以内</li></ul>
|
|
31554
31034
|
:type BusinessType: str
|
|
31555
31035
|
:param _FileInfos: <p>上传文件内容数组,一次最多可上传20个文件。</p><p><b>若上传多个文件,所有文件必须为相同类型</b>,例如全部为PDF或全部为Word文件。不支持混合文件类型的上传。</p>
|
|
31556
31036
|
:type FileInfos: list of UploadFile
|
|
@@ -31578,7 +31058,7 @@ class UploadFilesRequest(AbstractModel):
|
|
|
31578
31058
|
|
|
31579
31059
|
@property
|
|
31580
31060
|
def BusinessType(self):
|
|
31581
|
-
r"""<p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/
|
|
31061
|
+
r"""<p>文件对应业务类型,可以选择的类型如下</p><p>枚举值:</p><ul><li>TEMPLATE: 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT: 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件,用来发起流程,还需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同,直接上传后使用返回的文件资源Id即可</li><li>SEAL: 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE: 此文件用于归档文件夹,文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE: 此文件用于上传营业执照,用于后续<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>认证子客的时候提供营业执照,文件类型支持.jpg/.jpeg/.png,限制8M以内</li></ul>
|
|
31582
31062
|
:rtype: str
|
|
31583
31063
|
"""
|
|
31584
31064
|
return self._BusinessType
|