tencentcloud-sdk-python-ess 3.1.120__tar.gz → 3.1.123__tar.gz
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_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/PKG-INFO +2 -2
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/setup.py +1 -1
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/__init__.py +1 -1
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/ess_client.py +37 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/ess_client_async.py +32 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/models.py +176 -78
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
- tencentcloud_sdk_python_ess-3.1.123/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
- tencentcloud_sdk_python_ess-3.1.120/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/README.rst +0 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/setup.cfg +0 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/__init__.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/__init__.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
- {tencentcloud_sdk_python_ess-3.1.120 → tencentcloud_sdk_python_ess-3.1.123}/tencentcloud_sdk_python_ess.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: tencentcloud-sdk-python-ess
|
|
3
|
-
Version: 3.1.
|
|
3
|
+
Version: 3.1.123
|
|
4
4
|
Summary: Tencent Cloud Ess SDK for Python
|
|
5
5
|
Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
|
|
6
6
|
Author: Tencent Cloud
|
|
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
|
|
|
15
15
|
Classifier: Programming Language :: Python :: 3
|
|
16
16
|
Classifier: Programming Language :: Python :: 3.6
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.7
|
|
18
|
-
Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.
|
|
18
|
+
Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.123
|
|
19
19
|
|
|
20
20
|
============================
|
|
21
21
|
Tencent Cloud SDK for Python
|
|
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
|
|
|
8
8
|
|
|
9
9
|
setup(
|
|
10
10
|
name='tencentcloud-sdk-python-ess',
|
|
11
|
-
install_requires=["tencentcloud-sdk-python-common>=3.1.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common>=3.1.123,<4.0.0"],
|
|
12
12
|
|
|
13
13
|
version=tencentcloud.__version__,
|
|
14
14
|
description='Tencent Cloud Ess SDK for Python',
|
|
@@ -153,6 +153,43 @@ class EssClient(AbstractClient):
|
|
|
153
153
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
154
154
|
|
|
155
155
|
|
|
156
|
+
def CancelOrganizationFlows(self, request):
|
|
157
|
+
r"""全量撤销企业所有签署中的合同,单次任务最多支持撤销3000份合同。
|
|
158
|
+
|
|
159
|
+
适用场景:在企业信息变更场景下,签署中的合同需要全部撤销,全部重新发起,则可通过该接口取消签署中的合同流程,<font color='red'>需注意:该接口会将企业下签署中的合同都进行撤销操作,谨慎使用此接口。</font>
|
|
160
|
+
|
|
161
|
+
- **可撤回合同状态**:未全部签署完成
|
|
162
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
163
|
+
|
|
164
|
+
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
注:
|
|
168
|
+
- 有对应合同撤销权限的人: <font color='red'>**发起人所在企业的超管、法人**</font>
|
|
169
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
170
|
+
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
171
|
+
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
172
|
+
|
|
173
|
+
:param request: Request instance for CancelOrganizationFlows.
|
|
174
|
+
:type request: :class:`tencentcloud.ess.v20201111.models.CancelOrganizationFlowsRequest`
|
|
175
|
+
:rtype: :class:`tencentcloud.ess.v20201111.models.CancelOrganizationFlowsResponse`
|
|
176
|
+
|
|
177
|
+
"""
|
|
178
|
+
try:
|
|
179
|
+
params = request._serialize()
|
|
180
|
+
headers = request.headers
|
|
181
|
+
body = self.call("CancelOrganizationFlows", params, headers=headers)
|
|
182
|
+
response = json.loads(body)
|
|
183
|
+
model = models.CancelOrganizationFlowsResponse()
|
|
184
|
+
model._deserialize(response["Response"])
|
|
185
|
+
return model
|
|
186
|
+
except Exception as e:
|
|
187
|
+
if isinstance(e, TencentCloudSDKException):
|
|
188
|
+
raise
|
|
189
|
+
else:
|
|
190
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
191
|
+
|
|
192
|
+
|
|
156
193
|
def CancelUserAutoSignEnableUrl(self, request):
|
|
157
194
|
r"""用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接,撤销生成的链接失效。
|
|
158
195
|
|
|
@@ -132,6 +132,38 @@ class EssClient(AbstractClient):
|
|
|
132
132
|
|
|
133
133
|
return await self.call_and_deserialize(**kwargs)
|
|
134
134
|
|
|
135
|
+
async def CancelOrganizationFlows(
|
|
136
|
+
self,
|
|
137
|
+
request: models.CancelOrganizationFlowsRequest,
|
|
138
|
+
opts: Dict = None,
|
|
139
|
+
) -> models.CancelOrganizationFlowsResponse:
|
|
140
|
+
"""
|
|
141
|
+
全量撤销企业所有签署中的合同,单次任务最多支持撤销3000份合同。
|
|
142
|
+
|
|
143
|
+
适用场景:在企业信息变更场景下,签署中的合同需要全部撤销,全部重新发起,则可通过该接口取消签署中的合同流程,<font color='red'>需注意:该接口会将企业下签署中的合同都进行撤销操作,谨慎使用此接口。</font>
|
|
144
|
+
|
|
145
|
+
- **可撤回合同状态**:未全部签署完成
|
|
146
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
147
|
+
|
|
148
|
+
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
注:
|
|
152
|
+
- 有对应合同撤销权限的人: <font color='red'>**发起人所在企业的超管、法人**</font>
|
|
153
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
154
|
+
- <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
155
|
+
- 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
|
|
156
|
+
"""
|
|
157
|
+
|
|
158
|
+
kwargs = {}
|
|
159
|
+
kwargs["action"] = "CancelOrganizationFlows"
|
|
160
|
+
kwargs["params"] = request._serialize()
|
|
161
|
+
kwargs["resp_cls"] = models.CancelOrganizationFlowsResponse
|
|
162
|
+
kwargs["headers"] = request.headers
|
|
163
|
+
kwargs["opts"] = opts or {}
|
|
164
|
+
|
|
165
|
+
return await self.call_and_deserialize(**kwargs)
|
|
166
|
+
|
|
135
167
|
async def CancelUserAutoSignEnableUrl(
|
|
136
168
|
self,
|
|
137
169
|
request: models.CancelUserAutoSignEnableUrlRequest,
|
|
@@ -3006,6 +3006,134 @@ class CancelMultiFlowSignQRCodeResponse(AbstractModel):
|
|
|
3006
3006
|
self._RequestId = params.get("RequestId")
|
|
3007
3007
|
|
|
3008
3008
|
|
|
3009
|
+
class CancelOrganizationFlowsRequest(AbstractModel):
|
|
3010
|
+
r"""CancelOrganizationFlows请求参数结构体
|
|
3011
|
+
|
|
3012
|
+
"""
|
|
3013
|
+
|
|
3014
|
+
def __init__(self):
|
|
3015
|
+
r"""
|
|
3016
|
+
:param _Operator: <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证</p>
|
|
3017
|
+
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
3018
|
+
:param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
3019
|
+
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
3020
|
+
:param _CancelMessage: <p>撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。 备注:<code>如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"</code></p>
|
|
3021
|
+
:type CancelMessage: str
|
|
3022
|
+
:param _CancelMessageFormat: <p>撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:<strong>0</strong> : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同<strong>1</strong> : 合同封面页面会展示为: 发起方以<strong>CancelMessage</strong>的理由撤销当前合同<strong>2</strong> : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同<strong>3</strong> : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: <code>CancelMessage为撤销当前合同的理由</code><img src="https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png" alt="image"></p><p>枚举值:</p><ul><li>0: 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同</li><li>1: 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同</li><li>2: 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同</li><li>3: 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: CancelMessage为撤销当前合同的理由</li></ul>
|
|
3023
|
+
:type CancelMessageFormat: int
|
|
3024
|
+
"""
|
|
3025
|
+
self._Operator = None
|
|
3026
|
+
self._Agent = None
|
|
3027
|
+
self._CancelMessage = None
|
|
3028
|
+
self._CancelMessageFormat = None
|
|
3029
|
+
|
|
3030
|
+
@property
|
|
3031
|
+
def Operator(self):
|
|
3032
|
+
r"""<p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证</p>
|
|
3033
|
+
:rtype: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
3034
|
+
"""
|
|
3035
|
+
return self._Operator
|
|
3036
|
+
|
|
3037
|
+
@Operator.setter
|
|
3038
|
+
def Operator(self, Operator):
|
|
3039
|
+
self._Operator = Operator
|
|
3040
|
+
|
|
3041
|
+
@property
|
|
3042
|
+
def Agent(self):
|
|
3043
|
+
r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
3044
|
+
:rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
3045
|
+
"""
|
|
3046
|
+
return self._Agent
|
|
3047
|
+
|
|
3048
|
+
@Agent.setter
|
|
3049
|
+
def Agent(self, Agent):
|
|
3050
|
+
self._Agent = Agent
|
|
3051
|
+
|
|
3052
|
+
@property
|
|
3053
|
+
def CancelMessage(self):
|
|
3054
|
+
r"""<p>撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。 备注:<code>如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"</code></p>
|
|
3055
|
+
:rtype: str
|
|
3056
|
+
"""
|
|
3057
|
+
return self._CancelMessage
|
|
3058
|
+
|
|
3059
|
+
@CancelMessage.setter
|
|
3060
|
+
def CancelMessage(self, CancelMessage):
|
|
3061
|
+
self._CancelMessage = CancelMessage
|
|
3062
|
+
|
|
3063
|
+
@property
|
|
3064
|
+
def CancelMessageFormat(self):
|
|
3065
|
+
r"""<p>撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:<strong>0</strong> : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同<strong>1</strong> : 合同封面页面会展示为: 发起方以<strong>CancelMessage</strong>的理由撤销当前合同<strong>2</strong> : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以<strong>CancelMessage</strong>的理由撤销当前合同<strong>3</strong> : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以<strong>CancelMessage</strong>的理由撤销当前合同注: <code>CancelMessage为撤销当前合同的理由</code><img src="https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png" alt="image"></p><p>枚举值:</p><ul><li>0: 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同</li><li>1: 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同</li><li>2: 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同</li><li>3: 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: CancelMessage为撤销当前合同的理由</li></ul>
|
|
3066
|
+
:rtype: int
|
|
3067
|
+
"""
|
|
3068
|
+
return self._CancelMessageFormat
|
|
3069
|
+
|
|
3070
|
+
@CancelMessageFormat.setter
|
|
3071
|
+
def CancelMessageFormat(self, CancelMessageFormat):
|
|
3072
|
+
self._CancelMessageFormat = CancelMessageFormat
|
|
3073
|
+
|
|
3074
|
+
|
|
3075
|
+
def _deserialize(self, params):
|
|
3076
|
+
if params.get("Operator") is not None:
|
|
3077
|
+
self._Operator = UserInfo()
|
|
3078
|
+
self._Operator._deserialize(params.get("Operator"))
|
|
3079
|
+
if params.get("Agent") is not None:
|
|
3080
|
+
self._Agent = Agent()
|
|
3081
|
+
self._Agent._deserialize(params.get("Agent"))
|
|
3082
|
+
self._CancelMessage = params.get("CancelMessage")
|
|
3083
|
+
self._CancelMessageFormat = params.get("CancelMessageFormat")
|
|
3084
|
+
memeber_set = set(params.keys())
|
|
3085
|
+
for name, value in vars(self).items():
|
|
3086
|
+
property_name = name[1:]
|
|
3087
|
+
if property_name in memeber_set:
|
|
3088
|
+
memeber_set.remove(property_name)
|
|
3089
|
+
if len(memeber_set) > 0:
|
|
3090
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
3091
|
+
|
|
3092
|
+
|
|
3093
|
+
|
|
3094
|
+
class CancelOrganizationFlowsResponse(AbstractModel):
|
|
3095
|
+
r"""CancelOrganizationFlows返回参数结构体
|
|
3096
|
+
|
|
3097
|
+
"""
|
|
3098
|
+
|
|
3099
|
+
def __init__(self):
|
|
3100
|
+
r"""
|
|
3101
|
+
:param _TaskId: <p>批量撤销任务编号,为32位字符串,可用于<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">批量撤销任务结果回调</a></p>
|
|
3102
|
+
:type TaskId: str
|
|
3103
|
+
:param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3104
|
+
:type RequestId: str
|
|
3105
|
+
"""
|
|
3106
|
+
self._TaskId = None
|
|
3107
|
+
self._RequestId = None
|
|
3108
|
+
|
|
3109
|
+
@property
|
|
3110
|
+
def TaskId(self):
|
|
3111
|
+
r"""<p>批量撤销任务编号,为32位字符串,可用于<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask">查询批量撤销合同结果</a> 或关联<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83">批量撤销任务结果回调</a></p>
|
|
3112
|
+
:rtype: str
|
|
3113
|
+
"""
|
|
3114
|
+
return self._TaskId
|
|
3115
|
+
|
|
3116
|
+
@TaskId.setter
|
|
3117
|
+
def TaskId(self, TaskId):
|
|
3118
|
+
self._TaskId = TaskId
|
|
3119
|
+
|
|
3120
|
+
@property
|
|
3121
|
+
def RequestId(self):
|
|
3122
|
+
r"""唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3123
|
+
:rtype: str
|
|
3124
|
+
"""
|
|
3125
|
+
return self._RequestId
|
|
3126
|
+
|
|
3127
|
+
@RequestId.setter
|
|
3128
|
+
def RequestId(self, RequestId):
|
|
3129
|
+
self._RequestId = RequestId
|
|
3130
|
+
|
|
3131
|
+
|
|
3132
|
+
def _deserialize(self, params):
|
|
3133
|
+
self._TaskId = params.get("TaskId")
|
|
3134
|
+
self._RequestId = params.get("RequestId")
|
|
3135
|
+
|
|
3136
|
+
|
|
3009
3137
|
class CancelUserAutoSignEnableUrlRequest(AbstractModel):
|
|
3010
3138
|
r"""CancelUserAutoSignEnableUrl请求参数结构体
|
|
3011
3139
|
|
|
@@ -35114,59 +35242,36 @@ class FlowGroupInfo(AbstractModel):
|
|
|
35114
35242
|
|
|
35115
35243
|
def __init__(self):
|
|
35116
35244
|
r"""
|
|
35117
|
-
:param _FlowName:
|
|
35118
|
-
该名称还将用于合同签署完成后的下载文件名。
|
|
35245
|
+
:param _FlowName: <p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。<br>该名称还将用于合同签署完成后的下载文件名。</p>
|
|
35119
35246
|
:type FlowName: str
|
|
35120
|
-
:param _Approvers:
|
|
35121
|
-
注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
|
|
35247
|
+
:param _Approvers: <p>签署流程参与者信息,最大限制50方<br>注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。</p>
|
|
35122
35248
|
:type Approvers: list of ApproverInfo
|
|
35123
|
-
:param _FileIds:
|
|
35124
|
-
注:此字段定义为数组,但仅支持单个文件
|
|
35249
|
+
:param _FileIds: <p>文件资源ID,通过多文件上传<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获得,为32位字符串。<br>注:此字段定义为数组,但仅支持单个文件</p>
|
|
35125
35250
|
:type FileIds: list of str
|
|
35126
|
-
:param _TemplateId:
|
|
35127
|
-
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
35128
|
-
可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
|
35251
|
+
:param _TemplateId: <p>合同模板ID,为32位字符串。<br>建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。<br>可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。</p>
|
|
35129
35252
|
:type TemplateId: str
|
|
35130
|
-
:param _FlowType:
|
|
35253
|
+
:param _FlowType: <p>签署流程的类型(如销售合同/入职合同等),最大长度200个字符</p>
|
|
35131
35254
|
:type FlowType: str
|
|
35132
|
-
:param _FlowDescription:
|
|
35255
|
+
:param _FlowDescription: <p>签署流程描述,最大长度1000个字符</p>
|
|
35133
35256
|
:type FlowDescription: str
|
|
35134
|
-
:param _Deadline:
|
|
35135
|
-
|
|
35136
|
-
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
35137
|
-
示例值:1604912664
|
|
35257
|
+
:param _Deadline: <p>签署流程的签署截止时间。</p><p>值为unix时间戳,精确到秒,不传默认为当前时间一年后<br>示例值:1604912664</p>
|
|
35138
35258
|
:type Deadline: int
|
|
35139
|
-
:param _CallbackUrl:
|
|
35259
|
+
:param _CallbackUrl: <p>合同(流程)的回调地址</p>
|
|
35140
35260
|
:type CallbackUrl: str
|
|
35141
|
-
:param _UserData:
|
|
35142
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
35143
|
-
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
35261
|
+
:param _UserData: <p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。<br>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
|
|
35144
35262
|
:type UserData: str
|
|
35145
|
-
:param _Unordered:
|
|
35146
|
-
true:无序签
|
|
35147
|
-
false:有序签
|
|
35148
|
-
注:默认为false(有序签),请和模板中的配置保持一致
|
|
35149
|
-
示例值:true
|
|
35263
|
+
:param _Unordered: <p>发送类型:<br>true:无序签<br>false:有序签<br>注:默认为false(有序签),请和模板中的配置保持一致<br>示例值:true</p>
|
|
35150
35264
|
:type Unordered: bool
|
|
35151
|
-
:param _Components:
|
|
35152
|
-
<ul><li>单行文本控件</li>
|
|
35153
|
-
<li>多行文本控件</li>
|
|
35154
|
-
<li>勾选框控件</li>
|
|
35155
|
-
<li>数字控件</li>
|
|
35156
|
-
<li>图片控件</li>
|
|
35157
|
-
<li>动态表格等填写控件</li></ul>
|
|
35265
|
+
:param _Components: <p>模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li><li>动态表格等填写控件</li></ul>
|
|
35158
35266
|
:type Components: list of Component
|
|
35159
|
-
:param _NeedSignReview:
|
|
35160
|
-
若设置为true,审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
35161
|
-
|
|
35162
|
-
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
35163
|
-
示例值:true
|
|
35267
|
+
:param _NeedSignReview: <p>发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。<br>若设置为true,审核结果需通过接口 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview">CreateFlowSignReview</a> 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。</p><p>注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。<br>示例值:true</p>
|
|
35164
35268
|
:type NeedSignReview: bool
|
|
35165
|
-
:param _AutoSignScene:
|
|
35166
|
-
|
|
35269
|
+
:param _AutoSignScene: <p>个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN</p>
|
|
35167
35270
|
:type AutoSignScene: str
|
|
35168
|
-
:param _FlowDisplayType:
|
|
35271
|
+
: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>
|
|
35169
35272
|
:type FlowDisplayType: int
|
|
35273
|
+
:param _CcInfos: <p>抄送人信息</p>
|
|
35274
|
+
:type CcInfos: list of CcInfo
|
|
35170
35275
|
"""
|
|
35171
35276
|
self._FlowName = None
|
|
35172
35277
|
self._Approvers = None
|
|
@@ -35182,11 +35287,11 @@ false:有序签
|
|
|
35182
35287
|
self._NeedSignReview = None
|
|
35183
35288
|
self._AutoSignScene = None
|
|
35184
35289
|
self._FlowDisplayType = None
|
|
35290
|
+
self._CcInfos = None
|
|
35185
35291
|
|
|
35186
35292
|
@property
|
|
35187
35293
|
def FlowName(self):
|
|
35188
|
-
r"""
|
|
35189
|
-
该名称还将用于合同签署完成后的下载文件名。
|
|
35294
|
+
r"""<p>合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。<br>该名称还将用于合同签署完成后的下载文件名。</p>
|
|
35190
35295
|
:rtype: str
|
|
35191
35296
|
"""
|
|
35192
35297
|
return self._FlowName
|
|
@@ -35197,8 +35302,7 @@ false:有序签
|
|
|
35197
35302
|
|
|
35198
35303
|
@property
|
|
35199
35304
|
def Approvers(self):
|
|
35200
|
-
r"""
|
|
35201
|
-
注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
|
|
35305
|
+
r"""<p>签署流程参与者信息,最大限制50方<br>注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。</p>
|
|
35202
35306
|
:rtype: list of ApproverInfo
|
|
35203
35307
|
"""
|
|
35204
35308
|
return self._Approvers
|
|
@@ -35209,8 +35313,7 @@ false:有序签
|
|
|
35209
35313
|
|
|
35210
35314
|
@property
|
|
35211
35315
|
def FileIds(self):
|
|
35212
|
-
r"""
|
|
35213
|
-
注:此字段定义为数组,但仅支持单个文件
|
|
35316
|
+
r"""<p>文件资源ID,通过多文件上传<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles">UploadFiles</a>接口获得,为32位字符串。<br>注:此字段定义为数组,但仅支持单个文件</p>
|
|
35214
35317
|
:rtype: list of str
|
|
35215
35318
|
"""
|
|
35216
35319
|
return self._FileIds
|
|
@@ -35221,9 +35324,7 @@ false:有序签
|
|
|
35221
35324
|
|
|
35222
35325
|
@property
|
|
35223
35326
|
def TemplateId(self):
|
|
35224
|
-
r"""
|
|
35225
|
-
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
35226
|
-
可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
|
35327
|
+
r"""<p>合同模板ID,为32位字符串。<br>建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。<br>可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。</p>
|
|
35227
35328
|
:rtype: str
|
|
35228
35329
|
"""
|
|
35229
35330
|
return self._TemplateId
|
|
@@ -35234,7 +35335,7 @@ false:有序签
|
|
|
35234
35335
|
|
|
35235
35336
|
@property
|
|
35236
35337
|
def FlowType(self):
|
|
35237
|
-
r"""
|
|
35338
|
+
r"""<p>签署流程的类型(如销售合同/入职合同等),最大长度200个字符</p>
|
|
35238
35339
|
:rtype: str
|
|
35239
35340
|
"""
|
|
35240
35341
|
return self._FlowType
|
|
@@ -35245,7 +35346,7 @@ false:有序签
|
|
|
35245
35346
|
|
|
35246
35347
|
@property
|
|
35247
35348
|
def FlowDescription(self):
|
|
35248
|
-
r"""
|
|
35349
|
+
r"""<p>签署流程描述,最大长度1000个字符</p>
|
|
35249
35350
|
:rtype: str
|
|
35250
35351
|
"""
|
|
35251
35352
|
return self._FlowDescription
|
|
@@ -35256,10 +35357,7 @@ false:有序签
|
|
|
35256
35357
|
|
|
35257
35358
|
@property
|
|
35258
35359
|
def Deadline(self):
|
|
35259
|
-
r"""
|
|
35260
|
-
|
|
35261
|
-
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
35262
|
-
示例值:1604912664
|
|
35360
|
+
r"""<p>签署流程的签署截止时间。</p><p>值为unix时间戳,精确到秒,不传默认为当前时间一年后<br>示例值:1604912664</p>
|
|
35263
35361
|
:rtype: int
|
|
35264
35362
|
"""
|
|
35265
35363
|
return self._Deadline
|
|
@@ -35272,7 +35370,7 @@ false:有序签
|
|
|
35272
35370
|
def CallbackUrl(self):
|
|
35273
35371
|
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
|
|
35274
35372
|
|
|
35275
|
-
r"""
|
|
35373
|
+
r"""<p>合同(流程)的回调地址</p>
|
|
35276
35374
|
:rtype: str
|
|
35277
35375
|
"""
|
|
35278
35376
|
return self._CallbackUrl
|
|
@@ -35285,9 +35383,7 @@ false:有序签
|
|
|
35285
35383
|
|
|
35286
35384
|
@property
|
|
35287
35385
|
def UserData(self):
|
|
35288
|
-
r"""
|
|
35289
|
-
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
35290
|
-
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
35386
|
+
r"""<p>调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。<br>在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
|
|
35291
35387
|
:rtype: str
|
|
35292
35388
|
"""
|
|
35293
35389
|
return self._UserData
|
|
@@ -35298,11 +35394,7 @@ false:有序签
|
|
|
35298
35394
|
|
|
35299
35395
|
@property
|
|
35300
35396
|
def Unordered(self):
|
|
35301
|
-
r"""
|
|
35302
|
-
true:无序签
|
|
35303
|
-
false:有序签
|
|
35304
|
-
注:默认为false(有序签),请和模板中的配置保持一致
|
|
35305
|
-
示例值:true
|
|
35397
|
+
r"""<p>发送类型:<br>true:无序签<br>false:有序签<br>注:默认为false(有序签),请和模板中的配置保持一致<br>示例值:true</p>
|
|
35306
35398
|
:rtype: bool
|
|
35307
35399
|
"""
|
|
35308
35400
|
return self._Unordered
|
|
@@ -35313,13 +35405,7 @@ false:有序签
|
|
|
35313
35405
|
|
|
35314
35406
|
@property
|
|
35315
35407
|
def Components(self):
|
|
35316
|
-
r"""
|
|
35317
|
-
<ul><li>单行文本控件</li>
|
|
35318
|
-
<li>多行文本控件</li>
|
|
35319
|
-
<li>勾选框控件</li>
|
|
35320
|
-
<li>数字控件</li>
|
|
35321
|
-
<li>图片控件</li>
|
|
35322
|
-
<li>动态表格等填写控件</li></ul>
|
|
35408
|
+
r"""<p>模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体</p><ul><li>单行文本控件</li><li>多行文本控件</li><li>勾选框控件</li><li>数字控件</li><li>图片控件</li><li>动态表格等填写控件</li></ul>
|
|
35323
35409
|
:rtype: list of Component
|
|
35324
35410
|
"""
|
|
35325
35411
|
return self._Components
|
|
@@ -35330,11 +35416,7 @@ false:有序签
|
|
|
35330
35416
|
|
|
35331
35417
|
@property
|
|
35332
35418
|
def NeedSignReview(self):
|
|
35333
|
-
r"""
|
|
35334
|
-
若设置为true,审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
35335
|
-
|
|
35336
|
-
注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
35337
|
-
示例值:true
|
|
35419
|
+
r"""<p>发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。<br>若设置为true,审核结果需通过接口 <a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview">CreateFlowSignReview</a> 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。</p><p>注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。<br>示例值:true</p>
|
|
35338
35420
|
:rtype: bool
|
|
35339
35421
|
"""
|
|
35340
35422
|
return self._NeedSignReview
|
|
@@ -35345,8 +35427,7 @@ false:有序签
|
|
|
35345
35427
|
|
|
35346
35428
|
@property
|
|
35347
35429
|
def AutoSignScene(self):
|
|
35348
|
-
r"""
|
|
35349
|
-
|
|
35430
|
+
r"""<p>个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN</p>
|
|
35350
35431
|
:rtype: str
|
|
35351
35432
|
"""
|
|
35352
35433
|
return self._AutoSignScene
|
|
@@ -35357,7 +35438,7 @@ false:有序签
|
|
|
35357
35438
|
|
|
35358
35439
|
@property
|
|
35359
35440
|
def FlowDisplayType(self):
|
|
35360
|
-
r"""
|
|
35441
|
+
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>
|
|
35361
35442
|
:rtype: int
|
|
35362
35443
|
"""
|
|
35363
35444
|
return self._FlowDisplayType
|
|
@@ -35366,6 +35447,17 @@ false:有序签
|
|
|
35366
35447
|
def FlowDisplayType(self, FlowDisplayType):
|
|
35367
35448
|
self._FlowDisplayType = FlowDisplayType
|
|
35368
35449
|
|
|
35450
|
+
@property
|
|
35451
|
+
def CcInfos(self):
|
|
35452
|
+
r"""<p>抄送人信息</p>
|
|
35453
|
+
:rtype: list of CcInfo
|
|
35454
|
+
"""
|
|
35455
|
+
return self._CcInfos
|
|
35456
|
+
|
|
35457
|
+
@CcInfos.setter
|
|
35458
|
+
def CcInfos(self, CcInfos):
|
|
35459
|
+
self._CcInfos = CcInfos
|
|
35460
|
+
|
|
35369
35461
|
|
|
35370
35462
|
def _deserialize(self, params):
|
|
35371
35463
|
self._FlowName = params.get("FlowName")
|
|
@@ -35392,6 +35484,12 @@ false:有序签
|
|
|
35392
35484
|
self._NeedSignReview = params.get("NeedSignReview")
|
|
35393
35485
|
self._AutoSignScene = params.get("AutoSignScene")
|
|
35394
35486
|
self._FlowDisplayType = params.get("FlowDisplayType")
|
|
35487
|
+
if params.get("CcInfos") is not None:
|
|
35488
|
+
self._CcInfos = []
|
|
35489
|
+
for item in params.get("CcInfos"):
|
|
35490
|
+
obj = CcInfo()
|
|
35491
|
+
obj._deserialize(item)
|
|
35492
|
+
self._CcInfos.append(obj)
|
|
35395
35493
|
memeber_set = set(params.keys())
|
|
35396
35494
|
for name, value in vars(self).items():
|
|
35397
35495
|
property_name = name[1:]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: tencentcloud-sdk-python-ess
|
|
3
|
-
Version: 3.1.
|
|
3
|
+
Version: 3.1.123
|
|
4
4
|
Summary: Tencent Cloud Ess SDK for Python
|
|
5
5
|
Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
|
|
6
6
|
Author: Tencent Cloud
|
|
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
|
|
|
15
15
|
Classifier: Programming Language :: Python :: 3
|
|
16
16
|
Classifier: Programming Language :: Python :: 3.6
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.7
|
|
18
|
-
Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.
|
|
18
|
+
Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.123
|
|
19
19
|
|
|
20
20
|
============================
|
|
21
21
|
Tencent Cloud SDK for Python
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
tencentcloud-sdk-python-common<4.0.0,>=3.1.123
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
tencentcloud-sdk-python-common<4.0.0,>=3.1.120
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|