tencentcloud-sdk-python 3.0.1015__py2.py3-none-any.whl → 3.0.1017__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of tencentcloud-sdk-python might be problematic. Click here for more details.

Files changed (27) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/ccc/v20200210/models.py +29 -0
  3. tencentcloud/clb/v20180317/errorcodes.py +3 -0
  4. tencentcloud/csip/v20221121/models.py +39 -0
  5. tencentcloud/dnspod/v20210323/dnspod_client.py +92 -0
  6. tencentcloud/dnspod/v20210323/errorcodes.py +33 -0
  7. tencentcloud/dnspod/v20210323/models.py +462 -0
  8. tencentcloud/drm/v20181115/drm_client.py +23 -0
  9. tencentcloud/drm/v20181115/models.py +118 -0
  10. tencentcloud/ess/v20201111/ess_client.py +30 -0
  11. tencentcloud/ess/v20201111/models.py +172 -3
  12. tencentcloud/essbasic/v20210526/errorcodes.py +3 -0
  13. tencentcloud/essbasic/v20210526/essbasic_client.py +101 -42
  14. tencentcloud/essbasic/v20210526/models.py +479 -133
  15. tencentcloud/facefusion/v20181201/models.py +5 -4
  16. tencentcloud/tdmq/v20200217/models.py +582 -0
  17. tencentcloud/tdmq/v20200217/tdmq_client.py +69 -0
  18. tencentcloud/teo/v20220901/models.py +1 -1
  19. tencentcloud/tione/v20211111/models.py +62 -0
  20. tencentcloud/vpc/v20170312/models.py +17 -3
  21. tencentcloud/vrs/v20200824/models.py +26 -1
  22. tencentcloud/waf/v20180125/waf_client.py +6 -2
  23. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/METADATA +1 -1
  24. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/RECORD +27 -27
  25. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/LICENSE +0 -0
  26. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/WHEEL +0 -0
  27. {tencentcloud_sdk_python-3.0.1015.dist-info → tencentcloud_sdk_python-3.0.1017.dist-info}/top_level.txt +0 -0
@@ -256,7 +256,9 @@ class ApproverInfo(AbstractModel):
256
256
  <li> **3** :见证人</li></ul>
257
257
  注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
258
258
  :type ApproverRole: int
259
- :param _ApproverRoleName: 自定义签署人角色名:收款人、开具人、见证人
259
+ :param _ApproverRoleName: 可以自定义签署人角色名:收款人、开具人、见证人等,长度不能超过20,只能由中文、字母、数字和下划线组成。
260
+
261
+ 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
260
262
  :type ApproverRoleName: str
261
263
  :param _VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
262
264
 
@@ -289,7 +291,7 @@ class ApproverInfo(AbstractModel):
289
291
  </li></ul>
290
292
  注:
291
293
  <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
292
- <li>此字段不可传多个校验方式</li></ul>
294
+ <li>此字段可传多个校验方式</li></ul>
293
295
  :type ApproverVerifyTypes: list of int
294
296
  :param _ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
295
297
  <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
@@ -2263,6 +2265,173 @@ class CreateBatchCancelFlowUrlResponse(AbstractModel):
2263
2265
  self._RequestId = params.get("RequestId")
2264
2266
 
2265
2267
 
2268
+ class CreateBatchQuickSignUrlRequest(AbstractModel):
2269
+ """CreateBatchQuickSignUrl请求参数结构体
2270
+
2271
+ """
2272
+
2273
+ def __init__(self):
2274
+ r"""
2275
+ :param _FlowIds: 批量签署的合同流程ID数组。
2276
+ 注: `在调用此接口时,请确保合同流程均为本企业发起,且合同数量不超过100个。`
2277
+ :type FlowIds: list of str
2278
+ :param _FlowApproverInfo: 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
2279
+ 注:
2280
+ `1. ApproverType目前只支持个人类型的签署人。`
2281
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
2282
+ `3. 当需要通过短信验证码签署时,手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
2283
+ :type FlowApproverInfo: :class:`tencentcloud.ess.v20201111.models.FlowCreateApprover`
2284
+ :param _Agent: 代理企业和员工的信息。
2285
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2286
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
2287
+ :param _Operator: 执行本接口操作的员工信息。
2288
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2289
+ :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
2290
+ :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
2291
+ :type JumpUrl: str
2292
+ :param _SignatureTypes: 指定批量签署合同的签名类型,可传递以下值:
2293
+ <ul><li>**0**:手写签名(默认)</li>
2294
+ <li>**1**:OCR楷体</li></ul>
2295
+ 注:
2296
+ <ul><li>默认情况下,签名类型为手写签名</li>
2297
+ <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
2298
+ :type SignatureTypes: list of int
2299
+ :param _ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值:
2300
+ <ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
2301
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
2302
+ 注:
2303
+ <ul><li>默认情况下,认证校验方式为人脸认证</li>
2304
+ <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
2305
+ :type ApproverSignTypes: list of int
2306
+ """
2307
+ self._FlowIds = None
2308
+ self._FlowApproverInfo = None
2309
+ self._Agent = None
2310
+ self._Operator = None
2311
+ self._JumpUrl = None
2312
+ self._SignatureTypes = None
2313
+ self._ApproverSignTypes = None
2314
+
2315
+ @property
2316
+ def FlowIds(self):
2317
+ return self._FlowIds
2318
+
2319
+ @FlowIds.setter
2320
+ def FlowIds(self, FlowIds):
2321
+ self._FlowIds = FlowIds
2322
+
2323
+ @property
2324
+ def FlowApproverInfo(self):
2325
+ return self._FlowApproverInfo
2326
+
2327
+ @FlowApproverInfo.setter
2328
+ def FlowApproverInfo(self, FlowApproverInfo):
2329
+ self._FlowApproverInfo = FlowApproverInfo
2330
+
2331
+ @property
2332
+ def Agent(self):
2333
+ return self._Agent
2334
+
2335
+ @Agent.setter
2336
+ def Agent(self, Agent):
2337
+ self._Agent = Agent
2338
+
2339
+ @property
2340
+ def Operator(self):
2341
+ return self._Operator
2342
+
2343
+ @Operator.setter
2344
+ def Operator(self, Operator):
2345
+ self._Operator = Operator
2346
+
2347
+ @property
2348
+ def JumpUrl(self):
2349
+ return self._JumpUrl
2350
+
2351
+ @JumpUrl.setter
2352
+ def JumpUrl(self, JumpUrl):
2353
+ self._JumpUrl = JumpUrl
2354
+
2355
+ @property
2356
+ def SignatureTypes(self):
2357
+ return self._SignatureTypes
2358
+
2359
+ @SignatureTypes.setter
2360
+ def SignatureTypes(self, SignatureTypes):
2361
+ self._SignatureTypes = SignatureTypes
2362
+
2363
+ @property
2364
+ def ApproverSignTypes(self):
2365
+ return self._ApproverSignTypes
2366
+
2367
+ @ApproverSignTypes.setter
2368
+ def ApproverSignTypes(self, ApproverSignTypes):
2369
+ self._ApproverSignTypes = ApproverSignTypes
2370
+
2371
+
2372
+ def _deserialize(self, params):
2373
+ self._FlowIds = params.get("FlowIds")
2374
+ if params.get("FlowApproverInfo") is not None:
2375
+ self._FlowApproverInfo = FlowCreateApprover()
2376
+ self._FlowApproverInfo._deserialize(params.get("FlowApproverInfo"))
2377
+ if params.get("Agent") is not None:
2378
+ self._Agent = Agent()
2379
+ self._Agent._deserialize(params.get("Agent"))
2380
+ if params.get("Operator") is not None:
2381
+ self._Operator = UserInfo()
2382
+ self._Operator._deserialize(params.get("Operator"))
2383
+ self._JumpUrl = params.get("JumpUrl")
2384
+ self._SignatureTypes = params.get("SignatureTypes")
2385
+ self._ApproverSignTypes = params.get("ApproverSignTypes")
2386
+ memeber_set = set(params.keys())
2387
+ for name, value in vars(self).items():
2388
+ property_name = name[1:]
2389
+ if property_name in memeber_set:
2390
+ memeber_set.remove(property_name)
2391
+ if len(memeber_set) > 0:
2392
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
2393
+
2394
+
2395
+
2396
+ class CreateBatchQuickSignUrlResponse(AbstractModel):
2397
+ """CreateBatchQuickSignUrl返回参数结构体
2398
+
2399
+ """
2400
+
2401
+ def __init__(self):
2402
+ r"""
2403
+ :param _FlowApproverUrlInfo: 签署人签署链接信息
2404
+ :type FlowApproverUrlInfo: :class:`tencentcloud.ess.v20201111.models.FlowApproverUrlInfo`
2405
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2406
+ :type RequestId: str
2407
+ """
2408
+ self._FlowApproverUrlInfo = None
2409
+ self._RequestId = None
2410
+
2411
+ @property
2412
+ def FlowApproverUrlInfo(self):
2413
+ return self._FlowApproverUrlInfo
2414
+
2415
+ @FlowApproverUrlInfo.setter
2416
+ def FlowApproverUrlInfo(self, FlowApproverUrlInfo):
2417
+ self._FlowApproverUrlInfo = FlowApproverUrlInfo
2418
+
2419
+ @property
2420
+ def RequestId(self):
2421
+ return self._RequestId
2422
+
2423
+ @RequestId.setter
2424
+ def RequestId(self, RequestId):
2425
+ self._RequestId = RequestId
2426
+
2427
+
2428
+ def _deserialize(self, params):
2429
+ if params.get("FlowApproverUrlInfo") is not None:
2430
+ self._FlowApproverUrlInfo = FlowApproverUrlInfo()
2431
+ self._FlowApproverUrlInfo._deserialize(params.get("FlowApproverUrlInfo"))
2432
+ self._RequestId = params.get("RequestId")
2433
+
2434
+
2266
2435
  class CreateBatchSignUrlRequest(AbstractModel):
2267
2436
  """CreateBatchSignUrl请求参数结构体
2268
2437
 
@@ -12866,7 +13035,7 @@ class FlowCreateApprover(AbstractModel):
12866
13035
  </li></ul>
12867
13036
  注:
12868
13037
  <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
12869
- <li>此字段不可传多个校验方式</li></ul>
13038
+ <li>此字段可传多个校验方式</li></ul>
12870
13039
 
12871
13040
  `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
12872
13041
 
@@ -365,6 +365,9 @@ MISSINGPARAMETER_USEROPENID = 'MissingParameter.UserOpenId'
365
365
  # 操作被拒绝。
366
366
  OPERATIONDENIED = 'OperationDenied'
367
367
 
368
+ # 相关资源已经存证, 无法在创建新的相关资源
369
+ OPERATIONDENIED_ALREADYHAS = 'OperationDenied.AlreadyHas'
370
+
368
371
  # 参与人信息有重复
369
372
  OPERATIONDENIED_APPROVERREPEAT = 'OperationDenied.ApproverRepeat'
370
373
 
@@ -27,22 +27,16 @@ class EssbasicClient(AbstractClient):
27
27
 
28
28
 
29
29
  def ChannelBatchCancelFlows(self, request):
30
- """用于批量撤销合同流程<br/>
31
- 适用场景:
32
- 如果某些合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
33
- 通过签署流程编号批量撤销合同,单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是,若合同处于以下已终止状态,则不可撤销:<br/>
34
- - 已全部签署完成
35
- - 已拒签
36
- - 已过期
37
- - 已撤回
38
- - 拒绝填写
39
- - 已解除
40
-
41
- <br/>
42
- 满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
43
- <br/><br/>
30
+ """通过合同编号批量撤销合同,单次最多支持撤销100份合同。
31
+
32
+ 适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
33
+
34
+ - **可撤回合同状态**:未全部签署完成
35
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
36
+
44
37
  注:
45
- `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
38
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
39
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
46
40
 
47
41
  :param request: Request instance for ChannelBatchCancelFlows.
48
42
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelBatchCancelFlowsRequest`
@@ -68,11 +62,13 @@ class EssbasicClient(AbstractClient):
68
62
  """撤销签署流程接口
69
63
 
70
64
  适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
71
- <ul><li> `可撤回合同状态` :未全部签署完成</li>
72
- <li> `不撤回合同状态` :已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。</li></ul>
65
+
66
+ - **可撤回合同状态**:未全部签署完成
67
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
68
+
73
69
  注:
74
- <ul><li>能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人` </li>
75
- <li>签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>。</li></ul>
70
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
71
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
76
72
 
77
73
  :param request: Request instance for ChannelCancelFlow.
78
74
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCancelFlowRequest`
@@ -143,15 +139,15 @@ class EssbasicClient(AbstractClient):
143
139
 
144
140
 
145
141
  def ChannelCreateBatchCancelFlowUrl(self, request):
146
- """指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
147
- 客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
148
- 接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
142
+ """通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
149
143
 
150
- 可以撤回:未全部签署完成
151
- 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
144
+ 适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
152
145
 
153
- 注意:
154
- 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
146
+ - **可撤回合同状态**:未全部签署完成
147
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
148
+
149
+ 注:
150
+ - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
155
151
 
156
152
  :param request: Request instance for ChannelCreateBatchCancelFlowUrl.
157
153
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchCancelFlowUrlRequest`
@@ -173,6 +169,36 @@ class EssbasicClient(AbstractClient):
173
169
  raise TencentCloudSDKException(type(e).__name__, str(e))
174
170
 
175
171
 
172
+ def ChannelCreateBatchQuickSignUrl(self, request):
173
+ """该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
174
+ `注意:`<br/>
175
+ `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
176
+ `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
177
+ `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
178
+ `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
179
+ `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
180
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
181
+
182
+ :param request: Request instance for ChannelCreateBatchQuickSignUrl.
183
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchQuickSignUrlRequest`
184
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchQuickSignUrlResponse`
185
+
186
+ """
187
+ try:
188
+ params = request._serialize()
189
+ headers = request.headers
190
+ body = self.call("ChannelCreateBatchQuickSignUrl", params, headers=headers)
191
+ response = json.loads(body)
192
+ model = models.ChannelCreateBatchQuickSignUrlResponse()
193
+ model._deserialize(response["Response"])
194
+ return model
195
+ except Exception as e:
196
+ if isinstance(e, TencentCloudSDKException):
197
+ raise
198
+ else:
199
+ raise TencentCloudSDKException(type(e).__name__, str(e))
200
+
201
+
176
202
  def ChannelCreateBatchSignUrl(self, request):
177
203
  """通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。
178
204
  请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
@@ -226,7 +252,14 @@ class EssbasicClient(AbstractClient):
226
252
 
227
253
 
228
254
  def ChannelCreateConvertTaskApi(self, request):
229
- """上传了word、excel、图片文件后,通过该接口发起文件转换任务,将wordexcel、图片文件转换为pdf文件。
255
+ """此接口(ChannelCreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
256
+ 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
257
+ 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
258
+ 适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
259
+ 转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
260
+ 注:
261
+ 1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
262
+ 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
230
263
 
231
264
  :param request: Request instance for ChannelCreateConvertTaskApi.
232
265
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateConvertTaskApiRequest`
@@ -767,8 +800,16 @@ class EssbasicClient(AbstractClient):
767
800
 
768
801
 
769
802
  def ChannelCreateReleaseFlow(self, request):
770
- """发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。
771
- 合同发起人必须在电子签已经进行实名。
803
+ """发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
804
+ 解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。
805
+
806
+ 注意:
807
+ <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
808
+ <li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
809
+ <li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
810
+ <li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
811
+ <li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
812
+ <li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
772
813
 
773
814
  :param request: Request instance for ChannelCreateReleaseFlow.
774
815
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateReleaseFlowRequest`
@@ -841,7 +882,9 @@ class EssbasicClient(AbstractClient):
841
882
 
842
883
 
843
884
  def ChannelCreateUserAutoSignEnableUrl(self, request):
844
- """企业方可以通过此接口获取个人用户开启自动签的跳转链接
885
+ """获取个人用户自动签的开通链接。
886
+
887
+ 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
845
888
 
846
889
  :param request: Request instance for ChannelCreateUserAutoSignEnableUrl.
847
890
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateUserAutoSignEnableUrlRequest`
@@ -1160,8 +1203,12 @@ class EssbasicClient(AbstractClient):
1160
1203
 
1161
1204
 
1162
1205
  def ChannelGetTaskResultApi(self, request):
1163
- """查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
1164
- 注意:大文件转换所需的时间可能会比较长。
1206
+ """此接口(ChannelGetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
1207
+ 前提条件:已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
1208
+
1209
+ 适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
1210
+ 注:
1211
+ 1. `大文件转换所需的时间可能会比较长`
1165
1212
 
1166
1213
  :param request: Request instance for ChannelGetTaskResultApi.
1167
1214
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelGetTaskResultApiRequest`
@@ -1655,15 +1702,27 @@ class EssbasicClient(AbstractClient):
1655
1702
  def DescribeTemplates(self, request):
1656
1703
  """通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
1657
1704
 
1658
- > **适用场景**
1659
- >
1660
- > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
1661
- > 一个模板通常会包含以下结构信息
1662
- >- 模板基本信息
1663
- >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
1664
- >- 填写控件 Components
1665
- >- 签署控件 SignComponents
1666
- >- 生成模板的文件基础信息 FileInfos
1705
+ **一个模板通常会包含以下结构信息**
1706
+
1707
+ - 模板模版ID, 模板名字等基本信息
1708
+ - 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
1709
+ - 发起方和签署方的填写控件 Components
1710
+ - 签署方的签署控件 SignComponents
1711
+
1712
+ **适用场景**
1713
+ 该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
1714
+ 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
1715
+
1716
+ **模版的来源**
1717
+ 子客企业的模板有两种途径获取
1718
+ - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
1719
+ - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
1720
+
1721
+
1722
+ **注意**
1723
+
1724
+ >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
1725
+ >2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
1667
1726
 
1668
1727
  :param request: Request instance for DescribeTemplates.
1669
1728
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeTemplatesRequest`
@@ -1830,7 +1889,7 @@ class EssbasicClient(AbstractClient):
1830
1889
  def PrepareFlows(self, request):
1831
1890
  """该接口 (PrepareFlows) 用于创建待发起文件
1832
1891
  用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
1833
- 目前该接口只支持B2C,不建议使用,将会废弃。
1892
+ 目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。
1834
1893
 
1835
1894
  :param request: Request instance for PrepareFlows.
1836
1895
  :type request: :class:`tencentcloud.essbasic.v20210526.models.PrepareFlowsRequest`