tencentcloud-sdk-python 3.0.1193__py2.py3-none-any.whl → 3.0.1195__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.
Files changed (41) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/autoscaling/v20180419/models.py +45 -3
  3. tencentcloud/ccc/v20200210/models.py +19 -1
  4. tencentcloud/cdb/v20170320/cdb_client.py +1 -1
  5. tencentcloud/cdb/v20170320/models.py +66 -1
  6. tencentcloud/ckafka/v20190819/ckafka_client.py +23 -0
  7. tencentcloud/ckafka/v20190819/models.py +192 -0
  8. tencentcloud/cvm/v20170312/cvm_client.py +46 -0
  9. tencentcloud/cvm/v20170312/errorcodes.py +3 -0
  10. tencentcloud/cvm/v20170312/models.py +152 -0
  11. tencentcloud/cynosdb/v20190107/cynosdb_client.py +46 -0
  12. tencentcloud/cynosdb/v20190107/errorcodes.py +3 -0
  13. tencentcloud/cynosdb/v20190107/models.py +298 -0
  14. tencentcloud/es/v20180416/models.py +48 -0
  15. tencentcloud/ess/v20201111/ess_client.py +67 -21
  16. tencentcloud/ess/v20201111/models.py +143 -16
  17. tencentcloud/essbasic/v20210526/essbasic_client.py +45 -30
  18. tencentcloud/essbasic/v20210526/models.py +13 -13
  19. tencentcloud/hunyuan/v20230901/models.py +129 -3
  20. tencentcloud/iss/v20230517/errorcodes.py +3 -0
  21. tencentcloud/iss/v20230517/models.py +2 -1
  22. tencentcloud/mna/v20210119/errorcodes.py +6 -0
  23. tencentcloud/mna/v20210119/mna_client.py +138 -0
  24. tencentcloud/mna/v20210119/models.py +651 -0
  25. tencentcloud/mongodb/v20190725/errorcodes.py +3 -0
  26. tencentcloud/mongodb/v20190725/models.py +6 -6
  27. tencentcloud/monitor/v20180724/models.py +29 -17
  28. tencentcloud/oceanus/v20190422/models.py +12 -0
  29. tencentcloud/postgres/v20170312/errorcodes.py +3 -0
  30. tencentcloud/postgres/v20170312/models.py +880 -20
  31. tencentcloud/postgres/v20170312/postgres_client.py +161 -0
  32. tencentcloud/rce/v20201103/models.py +153 -0
  33. tencentcloud/tcr/v20190924/models.py +45 -12
  34. tencentcloud/tcr/v20190924/tcr_client.py +2 -2
  35. tencentcloud/vpc/v20170312/models.py +1 -1
  36. tencentcloud/waf/v20180125/models.py +472 -4
  37. {tencentcloud_sdk_python-3.0.1193.dist-info → tencentcloud_sdk_python-3.0.1195.dist-info}/METADATA +1 -1
  38. {tencentcloud_sdk_python-3.0.1193.dist-info → tencentcloud_sdk_python-3.0.1195.dist-info}/RECORD +41 -41
  39. {tencentcloud_sdk_python-3.0.1193.dist-info → tencentcloud_sdk_python-3.0.1195.dist-info}/LICENSE +0 -0
  40. {tencentcloud_sdk_python-3.0.1193.dist-info → tencentcloud_sdk_python-3.0.1195.dist-info}/WHEEL +0 -0
  41. {tencentcloud_sdk_python-3.0.1193.dist-info → tencentcloud_sdk_python-3.0.1195.dist-info}/top_level.txt +0 -0
@@ -376,14 +376,18 @@ class EssClient(AbstractClient):
376
376
 
377
377
 
378
378
  def CreateEmbedWebUrl(self, request):
379
- """本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
379
+ """本接口(CreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
380
380
  1. 创建印章
381
381
  2. 创建模板
382
382
  3. 修改模板
383
383
  4. 预览模板
384
384
  5. 预览合同流程
385
385
 
386
- 用户可以通过这些链接快速将其集成到自己的系统中。
386
+ 预览模板的嵌入页面长相如下:
387
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
388
+
389
+ 预览合同流程的嵌入页面长相如下:
390
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)
387
391
 
388
392
  :param request: Request instance for CreateEmbedWebUrl.
389
393
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateEmbedWebUrlRequest`
@@ -1148,11 +1152,17 @@ class EssClient(AbstractClient):
1148
1152
 
1149
1153
  def CreateOrganizationBatchSignUrl(self, request):
1150
1154
  """使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
1151
- 附注:
1152
- - 员工必须需作为批量签署合同的签署方,or或签合同的候选人之一。
1153
- - 对于本方企业:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
1154
- - 若要生成他发企业签署链接:应传RecipientIds,且制定的合同必须是接口调用方发起的。
1155
- - 支持待签署、待填写状态的合同生成签署链接。
1155
+
1156
+ 注:
1157
+ <ul>
1158
+ <li>员工必须需作为批量签署合同的签署方,或者是或签合同的候选人之一。</li>
1159
+ <li><b>本方企业签署链接</b>:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。</li>
1160
+ <li><b>他方企业签署链接</b>:传RecipientIds,且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。(<b>如果签署人没有加入对方企业则会引导加入;如果对方企业还没有注册认证,会引导企业注册和认证</b>)</li>
1161
+ <li>只支持待签署、待填写状态的合同生成签署链接。</li>
1162
+ </ul>
1163
+
1164
+ 签署的嵌入页面长相如下:
1165
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)
1156
1166
 
1157
1167
  :param request: Request instance for CreateOrganizationBatchSignUrl.
1158
1168
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateOrganizationBatchSignUrlRequest`
@@ -1254,6 +1264,36 @@ class EssClient(AbstractClient):
1254
1264
  raise TencentCloudSDKException(type(e).__name__, str(e))
1255
1265
 
1256
1266
 
1267
+ def CreatePartnerAutoSignAuthUrl(self, request):
1268
+ """创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。
1269
+ 该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
1270
+
1271
+
1272
+
1273
+ 注:
1274
+ 1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)
1275
+ 2. 已经在授权中或者授权成功的企业,无法重复授权
1276
+
1277
+ :param request: Request instance for CreatePartnerAutoSignAuthUrl.
1278
+ :type request: :class:`tencentcloud.ess.v20201111.models.CreatePartnerAutoSignAuthUrlRequest`
1279
+ :rtype: :class:`tencentcloud.ess.v20201111.models.CreatePartnerAutoSignAuthUrlResponse`
1280
+
1281
+ """
1282
+ try:
1283
+ params = request._serialize()
1284
+ headers = request.headers
1285
+ body = self.call("CreatePartnerAutoSignAuthUrl", params, headers=headers)
1286
+ response = json.loads(body)
1287
+ model = models.CreatePartnerAutoSignAuthUrlResponse()
1288
+ model._deserialize(response["Response"])
1289
+ return model
1290
+ except Exception as e:
1291
+ if isinstance(e, TencentCloudSDKException):
1292
+ raise
1293
+ else:
1294
+ raise TencentCloudSDKException(type(e).__name__, str(e))
1295
+
1296
+
1257
1297
  def CreatePersonAuthCertificateImage(self, request):
1258
1298
  """获取个人用户认证证书图片下载URL
1259
1299
 
@@ -1288,9 +1328,12 @@ class EssClient(AbstractClient):
1288
1328
 
1289
1329
 
1290
1330
  def CreatePrepareFlow(self, request):
1291
- """创建发起流程web页面
1292
- <br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
1293
- <br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
1331
+ """创建发起流程Web页面,通过该接口可以获取发起流程的可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。在页面上完成签署控件等信息的编辑与确认后,可快速发起流程。
1332
+
1333
+ <br/>注意:调用接口后,<font color="red">流程不会立即发起,需在嵌入页面上点击【发起合同】按钮来发起流程</font>。
1334
+
1335
+ 嵌入页面长相如下:
1336
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
1294
1337
 
1295
1338
  :param request: Request instance for CreatePrepareFlow.
1296
1339
  :type request: :class:`tencentcloud.ess.v20201111.models.CreatePrepareFlowRequest`
@@ -2435,17 +2478,20 @@ class EssClient(AbstractClient):
2435
2478
 
2436
2479
 
2437
2480
  def ModifyFlowDeadline(self, request):
2438
- """在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:
2439
- 1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
2440
- 2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。
2441
-
2442
- 此接口有如下限制条件:
2443
- 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
2444
- 2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。
2445
- 3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
2446
- 4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
2447
- 5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
2448
- 6. 不支持操作合同组合同。
2481
+ """在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:
2482
+ 1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
2483
+ 2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。
2484
+
2485
+ 此接口存在以下限制:
2486
+ 1. 执行操作的员工须为<font color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
2487
+ 2. 延长整个签署流程时,<font color="red">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
2488
+ 3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。
2489
+ 4. 延长签署方截止时间时,<font color="red">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
2490
+ 5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
2491
+ 6. <font color="red">不支持操作合同组合同</font>。
2492
+
2493
+ 合同(流程)层面 截止时间控制台展示的位置:
2494
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/265b130136bf6e8f01f5880438467dfb.png)
2449
2495
 
2450
2496
  :param request: Request instance for ModifyFlowDeadline.
2451
2497
  :type request: :class:`tencentcloud.ess.v20201111.models.ModifyFlowDeadlineRequest`
@@ -300,7 +300,7 @@ class ApproverInfo(AbstractModel):
300
300
  :param _ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
301
301
  <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
302
302
  <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
303
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
303
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>
304
304
 
305
305
  默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
306
306
 
@@ -3716,7 +3716,7 @@ class CreateEmbedWebUrlRequest(AbstractModel):
3716
3716
  def __init__(self):
3717
3717
  r"""
3718
3718
  :param _Operator: 执行本接口操作的员工信息。
3719
- <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3719
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3720
3720
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
3721
3721
  :param _EmbedType: WEB嵌入资源类型,支持以下类型
3722
3722
  <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
@@ -3742,17 +3742,7 @@ class CreateEmbedWebUrlRequest(AbstractModel):
3742
3742
  :type Reviewer: :class:`tencentcloud.ess.v20201111.models.ReviewerInfo`
3743
3743
  :param _Option: 个性化参数,用于控制页面展示内容
3744
3744
  :type Option: :class:`tencentcloud.ess.v20201111.models.EmbedUrlOption`
3745
- :param _UserData: 用户自定义参数
3746
- <ul>
3747
- <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
3748
- <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li>
3749
- <li>支持的格式:json字符串的BASE64编码字符串</li>
3750
- <li>示例:<ul>
3751
- <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li>
3752
- <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li>
3753
- </ul>
3754
- </li>
3755
- </ul>
3745
+ :param _UserData: <ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li> <li>支持的格式:json字符串的BASE64编码字符串</li> <li>示例:<ul> <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li> <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li> </ul> </li> </ul>
3756
3746
  :type UserData: str
3757
3747
  """
3758
3748
  self._Operator = None
@@ -7874,8 +7864,11 @@ class CreateOrganizationBatchSignUrlRequest(AbstractModel):
7874
7864
  :param _UserId: 员工在腾讯电子签平台的独特身份标识,为32位字符串。
7875
7865
  您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
7876
7866
  UserId必须是传入合同(FlowId)中的签署人。
7877
- - 1. 若UserId为空,Name和Mobile 必须提供。
7878
- - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
7867
+
7868
+ <ul>
7869
+ <li>1. 若UserId为空,Name和Mobile 必须提供。</li>
7870
+ <li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li>
7871
+ </ul>
7879
7872
  :type UserId: str
7880
7873
  :param _Name: 员工姓名,必须与手机号码一起使用。
7881
7874
  如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
@@ -8268,6 +8261,140 @@ class CreateOrganizationInfoChangeUrlResponse(AbstractModel):
8268
8261
  self._RequestId = params.get("RequestId")
8269
8262
 
8270
8263
 
8264
+ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
8265
+ """CreatePartnerAutoSignAuthUrl请求参数结构体
8266
+
8267
+ """
8268
+
8269
+ def __init__(self):
8270
+ r"""
8271
+ :param _AuthorizedOrganizationId: 被授企业id
8272
+ :type AuthorizedOrganizationId: str
8273
+ :param _SealTypes: 指定印章类型,指定后只能选择该类型的印章进行授权支持以下印章类型:- OFFICIAL : 企业公章- CONTRACT : 合同专用章- FINANCE : 财务专用章- PERSONNEL : 人事专用章
8274
+ :type SealTypes: list of str
8275
+ :param _Agent: 代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8276
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
8277
+ :param _Operator: 执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
8278
+ :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
8279
+ """
8280
+ self._AuthorizedOrganizationId = None
8281
+ self._SealTypes = None
8282
+ self._Agent = None
8283
+ self._Operator = None
8284
+
8285
+ @property
8286
+ def AuthorizedOrganizationId(self):
8287
+ return self._AuthorizedOrganizationId
8288
+
8289
+ @AuthorizedOrganizationId.setter
8290
+ def AuthorizedOrganizationId(self, AuthorizedOrganizationId):
8291
+ self._AuthorizedOrganizationId = AuthorizedOrganizationId
8292
+
8293
+ @property
8294
+ def SealTypes(self):
8295
+ return self._SealTypes
8296
+
8297
+ @SealTypes.setter
8298
+ def SealTypes(self, SealTypes):
8299
+ self._SealTypes = SealTypes
8300
+
8301
+ @property
8302
+ def Agent(self):
8303
+ return self._Agent
8304
+
8305
+ @Agent.setter
8306
+ def Agent(self, Agent):
8307
+ self._Agent = Agent
8308
+
8309
+ @property
8310
+ def Operator(self):
8311
+ return self._Operator
8312
+
8313
+ @Operator.setter
8314
+ def Operator(self, Operator):
8315
+ self._Operator = Operator
8316
+
8317
+
8318
+ def _deserialize(self, params):
8319
+ self._AuthorizedOrganizationId = params.get("AuthorizedOrganizationId")
8320
+ self._SealTypes = params.get("SealTypes")
8321
+ if params.get("Agent") is not None:
8322
+ self._Agent = Agent()
8323
+ self._Agent._deserialize(params.get("Agent"))
8324
+ if params.get("Operator") is not None:
8325
+ self._Operator = UserInfo()
8326
+ self._Operator._deserialize(params.get("Operator"))
8327
+ memeber_set = set(params.keys())
8328
+ for name, value in vars(self).items():
8329
+ property_name = name[1:]
8330
+ if property_name in memeber_set:
8331
+ memeber_set.remove(property_name)
8332
+ if len(memeber_set) > 0:
8333
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
8334
+
8335
+
8336
+
8337
+ class CreatePartnerAutoSignAuthUrlResponse(AbstractModel):
8338
+ """CreatePartnerAutoSignAuthUrl返回参数结构体
8339
+
8340
+ """
8341
+
8342
+ def __init__(self):
8343
+ r"""
8344
+ :param _Url: 授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
8345
+ :type Url: str
8346
+ :param _MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
8347
+ :type MiniAppPath: str
8348
+ :param _ExpireTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
8349
+ :type ExpireTime: int
8350
+ :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
8351
+ :type RequestId: str
8352
+ """
8353
+ self._Url = None
8354
+ self._MiniAppPath = None
8355
+ self._ExpireTime = None
8356
+ self._RequestId = None
8357
+
8358
+ @property
8359
+ def Url(self):
8360
+ return self._Url
8361
+
8362
+ @Url.setter
8363
+ def Url(self, Url):
8364
+ self._Url = Url
8365
+
8366
+ @property
8367
+ def MiniAppPath(self):
8368
+ return self._MiniAppPath
8369
+
8370
+ @MiniAppPath.setter
8371
+ def MiniAppPath(self, MiniAppPath):
8372
+ self._MiniAppPath = MiniAppPath
8373
+
8374
+ @property
8375
+ def ExpireTime(self):
8376
+ return self._ExpireTime
8377
+
8378
+ @ExpireTime.setter
8379
+ def ExpireTime(self, ExpireTime):
8380
+ self._ExpireTime = ExpireTime
8381
+
8382
+ @property
8383
+ def RequestId(self):
8384
+ return self._RequestId
8385
+
8386
+ @RequestId.setter
8387
+ def RequestId(self, RequestId):
8388
+ self._RequestId = RequestId
8389
+
8390
+
8391
+ def _deserialize(self, params):
8392
+ self._Url = params.get("Url")
8393
+ self._MiniAppPath = params.get("MiniAppPath")
8394
+ self._ExpireTime = params.get("ExpireTime")
8395
+ self._RequestId = params.get("RequestId")
8396
+
8397
+
8271
8398
  class CreatePersonAuthCertificateImageRequest(AbstractModel):
8272
8399
  """CreatePersonAuthCertificateImage请求参数结构体
8273
8400
 
@@ -16837,7 +16964,7 @@ class FlowCreateApprover(AbstractModel):
16837
16964
  :param _ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
16838
16965
  <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
16839
16966
  <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
16840
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
16967
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>
16841
16968
  注:
16842
16969
  <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
16843
16970
  <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
@@ -217,7 +217,7 @@ class EssbasicClient(AbstractClient):
217
217
  - 参与人点击链接后需短信验证码才能查看合同内容。
218
218
  - 个人用户批量签署,需要传Name,Mobile,IdCardNumber(IdCardType) 参数。
219
219
  - saas企业员工用户批量签署,在传递了姓名等基本信息参数的情况下,还需要传OrganizationName(参与方所在企业名称)参数生成签署链接,<font color="red">请确保此企业已完成腾讯电子签企业认证</font>。
220
- - 子客企业员工用户批签签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color="red">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。
220
+ - 子客企业员工用户批量签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color="red">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。
221
221
  - 生成批量签署链接时,合同目标参与方状态需为<font color="red">待签署</font>状态。
222
222
  - 个人批量签署进行的合同的签名区, 全部变成<font color="red">手写签名</font>(不管合同里边设置的签名限制)来进行。
223
223
 
@@ -315,14 +315,18 @@ class EssbasicClient(AbstractClient):
315
315
 
316
316
 
317
317
  def ChannelCreateEmbedWebUrl(self, request):
318
- """本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
318
+ """本接口(ChannelCreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
319
+ 1. 创建印章
320
+ 2. 创建模板
321
+ 3. 修改模板
322
+ 4. 预览模板
323
+ 5. 预览合同流程
319
324
 
320
- 本接口下面功能的签署页面链接的生成
321
- - 创建印章
322
- - 创建模板
323
- - 修改模板
324
- - 预览模板
325
- - 预览合同流程
325
+ 预览模板的嵌入页面长相如下:
326
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
327
+
328
+ 预览合同流程的嵌入页面长相如下:
329
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)
326
330
 
327
331
  :param request: Request instance for ChannelCreateEmbedWebUrl.
328
332
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateEmbedWebUrlRequest`
@@ -740,6 +744,9 @@ class EssbasicClient(AbstractClient):
740
744
  - 仅支持传入待签署或者待领取的合同,待填写暂不支持。
741
745
  - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
742
746
 
747
+ 签署的嵌入页面长相如下:
748
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)
749
+
743
750
  :param request: Request instance for ChannelCreateOrganizationBatchSignUrl.
744
751
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateOrganizationBatchSignUrlRequest`
745
752
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateOrganizationBatchSignUrlResponse`
@@ -1490,16 +1497,20 @@ class EssbasicClient(AbstractClient):
1490
1497
 
1491
1498
 
1492
1499
  def CreateBatchOrganizationRegistrationTasks(self, request):
1493
- """本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接
1494
- 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
1500
+ """该接口用于批量创建企业认证链接, 可以支持PC浏览器,H5和小程序三种途径。
1501
+ 此接口为异步提交任务接口,需要与[查询子企业批量认证链接](https://qcloudimg.tencent-cloud.cn/raw/1d3737991b2a3be78002bd78a47d6917.png)配合使用,整体流程如下图。
1502
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
1503
+
1504
+
1505
+
1506
+ **注意**
1507
+
1508
+ 1. 单次最多创建10个子企业。
1509
+ 2. 一天内,同一家企业最多创建8000个子企业。
1510
+ 3. 同一批创建的子客户不能重复,包括企业名称、企业统一信用代码和子客户经办人openId。
1511
+ 4. 跳转到小程序的实现,请参考微信官方文档(分为<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>。
1495
1512
 
1496
- 批量创建链接有以下限制:
1497
- 1. 单次最多创建10个子客。
1498
- 2. 一天同一家企业最多创建8000个子客。
1499
- 3. 同一批创建的子客不能重复 其中包括 企业名称,企业统一信用代码,子客经办人openId。
1500
- 4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置
1501
1513
 
1502
- 注: 1. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<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>
1503
1514
 
1504
1515
  **腾讯电子签小程序的AppID 和 原始Id如下:**
1505
1516
 
@@ -1995,11 +2006,12 @@ class EssbasicClient(AbstractClient):
1995
2006
 
1996
2007
 
1997
2008
  def DescribeBatchOrganizationRegistrationUrls(self, request):
1998
- """此接口用于获取企业批量认证异步任务的状态及结果。
2009
+ """此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>获取到任务ID,然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。
2010
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
1999
2011
 
2000
- 前提条件:已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口,并得到了任务Id。
2001
2012
 
2002
- 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间
2013
+ 注:
2014
+ `异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间`
2003
2015
 
2004
2016
  :param request: Request instance for DescribeBatchOrganizationRegistrationUrls.
2005
2017
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeBatchOrganizationRegistrationUrlsRequest`
@@ -2405,17 +2417,20 @@ class EssbasicClient(AbstractClient):
2405
2417
 
2406
2418
 
2407
2419
  def ModifyFlowDeadline(self, request):
2408
- """在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:
2409
- 1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
2410
- 2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。
2411
-
2412
- 此接口有如下限制条件:
2413
- 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
2414
- 2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。
2415
- 3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
2416
- 4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
2417
- 5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
2418
- 6. 不支持操作合同组合同。
2420
+ """在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:
2421
+ 1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
2422
+ 2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。
2423
+
2424
+ 此接口存在以下限制:
2425
+ 1. 执行操作的员工须为<font color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
2426
+ 2. 延长整个签署流程时,<font color="red">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
2427
+ 3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。
2428
+ 4. 延长签署方截止时间时,<font color="red">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
2429
+ 5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
2430
+ 6. <font color="red">不支持操作合同组合同</font>。
2431
+
2432
+ 合同(流程)层面截止时间子企业控制台展示的位置:
2433
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/f0f88c0eb49a926da9a86e5a6e9efa8b.png)
2419
2434
 
2420
2435
  :param request: Request instance for ModifyFlowDeadline.
2421
2436
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ModifyFlowDeadlineRequest`
@@ -9631,8 +9631,7 @@ class CreateBatchOrganizationRegistrationTasksRequest(AbstractModel):
9631
9631
  </ul>
9632
9632
  第三方平台子客企业和员工必须已经经过实名认证
9633
9633
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9634
- :param _RegistrationOrganizations: 当前应用下子客的组织机构注册信息。
9635
- 一次最多支持10条认证流
9634
+ :param _RegistrationOrganizations: 当前应用下子企业的组织机构注册信息。最多支持查询10子企业。
9636
9635
  :type RegistrationOrganizations: list of RegistrationOrganizationInfo
9637
9636
  :param _Endpoint: 生成链接的类型:
9638
9637
  <ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
@@ -9641,7 +9640,7 @@ class CreateBatchOrganizationRegistrationTasksRequest(AbstractModel):
9641
9640
  <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
9642
9641
  <li>**H5**:第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
9643
9642
  <li>**SHORT_H5**:第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>
9644
- 示例值:PC
9643
+
9645
9644
 
9646
9645
  :type Endpoint: str
9647
9646
  """
@@ -9702,14 +9701,15 @@ class CreateBatchOrganizationRegistrationTasksResponse(AbstractModel):
9702
9701
 
9703
9702
  def __init__(self):
9704
9703
  r"""
9705
- :param _TaskId: 生成注册链接的任务Id
9706
- 根据这个id, 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程
9707
- 若存在其中任意一条链接错误,则返回具体的错误描述, 不会返回TaskId
9704
+ :param _TaskId: 生成注册链接的任务ID,后序根据这个任务ID 调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls" target="_blank">查询子企业批量认证链接</a>获取生成的链接,发给对应的客户使用。
9705
+
9706
+ 注:`如果有错误,则不会返回任务ID`
9708
9707
  :type TaskId: str
9709
- :param _ErrorMessages: 批量生成企业认证链接的详细错误信息,
9710
- 顺序与输入参数保持一致。
9711
- 若企业认证均成功生成,则不返回错误信息;
9712
- 若存在任何错误,则返回具体的错误描述。
9708
+ :param _ErrorMessages: 批量生成企业认证链接的详细错误信息,顺序与输入参数子企业列表顺序一致。
9709
+ <ul>
9710
+ <li>如果所有企业认证链接都成功生成,将不返回错误信息</li>
9711
+ <li>如果存在任何错误,将返回具体的错误描述。(没有错误的企业返回空字符串)</li>
9712
+ </ul>
9713
9713
  :type ErrorMessages: list of str
9714
9714
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9715
9715
  :type RequestId: str
@@ -12001,7 +12001,7 @@ class DescribeBatchOrganizationRegistrationUrlsRequest(AbstractModel):
12001
12001
  </ul>
12002
12002
  第三方平台子客企业和员工必须已经经过实名认证
12003
12003
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
12004
- :param _TaskId: 通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id
12004
+ :param _TaskId: 通过接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>调用得到的任务ID。
12005
12005
  :type TaskId: str
12006
12006
  """
12007
12007
  self._Agent = None
@@ -12046,7 +12046,7 @@ class DescribeBatchOrganizationRegistrationUrlsResponse(AbstractModel):
12046
12046
 
12047
12047
  def __init__(self):
12048
12048
  r"""
12049
- :param _OrganizationAuthUrls: 企业批量注册链接信息
12049
+ :param _OrganizationAuthUrls: 子企业注册认证的的链接列表
12050
12050
  :type OrganizationAuthUrls: list of OrganizationAuthUrl
12051
12051
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
12052
12052
  :type RequestId: str
@@ -14557,7 +14557,7 @@ class FlowApproverInfo(AbstractModel):
14557
14557
  :param _ApproverSignTypes: 签署人签署合同时的认证方式
14558
14558
  <ul><li> **1** :人脸认证</li>
14559
14559
  <li> **2** :签署密码</li>
14560
- <li> **3** :运营商三要素</li></ul>
14560
+ <li> **3** :运营商三要素(如果是港澳台客户,建议不要选择这个)</li></ul>
14561
14561
 
14562
14562
  默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
14563
14563