tencentcloud-sdk-python 3.0.1239__py2.py3-none-any.whl → 3.0.1240__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 CHANGED
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1239'
17
+ __version__ = '3.0.1240'
@@ -100,12 +100,14 @@ class AiartClient(AbstractClient):
100
100
 
101
101
 
102
102
  def QueryDrawPortraitJob(self, request):
103
- """AI 写真提供 AI 写真形象照的训练与生成能力,分为上传训练图片、训练模型、生成图片3个环节,需要依次调用对应接口。
104
- 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
105
- 生成图片分为提交任务和查询任务2个接口。
106
- - 提交生成写真图片任务:完成训练写真模型后,选择写真风格模板,提交一个生成写真图片异步任务,根据写真模型 ID 开始生成人物形象在指定风格上的写真图片,获得任务 ID。
103
+ """AI 写真分为上传训练图片、训练写真模型(可选跳过)、生成写真图片3个环节,需要依次调用对应接口。
104
+ 生成图片分为提交任务和查询任务2个接口:
105
+
106
+ - 提交生成写真图片任务:选择风格模板,提交一个生成写真图片异步任务,根据写真模型 ID 生成写真图片,获得任务 ID。
107
107
  - 查询生成写真图片任务:根据任务 ID 查询生成图片任务的处理状态、处理结果。
108
108
 
109
+ 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
110
+
109
111
  :param request: Request instance for QueryDrawPortraitJob.
110
112
  :type request: :class:`tencentcloud.aiart.v20221229.models.QueryDrawPortraitJobRequest`
111
113
  :rtype: :class:`tencentcloud.aiart.v20221229.models.QueryDrawPortraitJobResponse`
@@ -154,12 +156,15 @@ class AiartClient(AbstractClient):
154
156
 
155
157
 
156
158
  def QueryTrainPortraitModelJob(self, request):
157
- """AI 写真提供 AI 写真形象照的训练与生成能力,分为上传训练图片、训练模型、生成图片3个环节,需要依次调用对应接口。
158
- 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
159
- 训练模型分为提交任务和查询任务2个接口。
160
- - 提交训练写真模型任务:完成上传训练图片后,提交一个训练写真模型异步任务,根据写真模型 ID 开始训练模型。
159
+ """AI 写真分为上传训练图片、训练写真模型(可选跳过)、生成写真图片3个环节,需要依次调用对应接口。
160
+ 如果选择免训练模式无需调用本接口。
161
+ 训练模型分为提交任务和查询任务2个接口:
162
+
163
+ - 提交训练写真模型任务:完成上传图片后,提交一个训练写真模型异步任务,根据写真模型 ID 开始训练模型。
161
164
  - 查询训练写真模型任务:根据写真模型 ID 查询训练任务的处理状态、处理结果。
162
165
 
166
+ 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
167
+
163
168
  :param request: Request instance for QueryTrainPortraitModelJob.
164
169
  :type request: :class:`tencentcloud.aiart.v20221229.models.QueryTrainPortraitModelJobRequest`
165
170
  :rtype: :class:`tencentcloud.aiart.v20221229.models.QueryTrainPortraitModelJobResponse`
@@ -230,13 +235,14 @@ class AiartClient(AbstractClient):
230
235
 
231
236
 
232
237
  def SubmitDrawPortraitJob(self, request):
233
- """AI 写真提供 AI 写真形象照的训练与生成能力,分为上传训练图片、训练模型、生成图片3个环节,需要依次调用对应接口。
234
- 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
235
- 生成图片分为提交任务和查询任务2个接口。
236
- - 提交生成写真图片任务:完成训练写真模型后,选择风格模板,提交一个生成写真图片异步任务,根据写真模型 ID 开始生成人物形象在指定风格上的写真图片,获得任务 ID。
238
+ """AI 写真分为上传训练图片、训练写真模型(可选跳过)、生成写真图片3个环节,需要依次调用对应接口。
239
+ 生成图片分为提交任务和查询任务2个接口:
240
+
241
+ - 提交生成写真图片任务:选择风格模板,提交一个生成写真图片异步任务,根据写真模型 ID 生成写真图片,获得任务 ID。
237
242
  - 查询生成写真图片任务:根据任务 ID 查询生成图片任务的处理状态、处理结果。
238
243
 
239
- 提交生成写真图片任务默认提供1个并发任务数。
244
+ 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
245
+ 提交生成写真图片任务默认提供1个并发。
240
246
 
241
247
  :param request: Request instance for SubmitDrawPortraitJob.
242
248
  :type request: :class:`tencentcloud.aiart.v20221229.models.SubmitDrawPortraitJobRequest`
@@ -286,12 +292,14 @@ class AiartClient(AbstractClient):
286
292
 
287
293
 
288
294
  def SubmitTrainPortraitModelJob(self, request):
289
- """AI 写真提供 AI 写真形象照的训练与生成能力,分为上传训练图片、训练模型、生成图片3个环节,需要依次调用对应接口。
290
- 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
291
- 训练模型分为提交任务和查询任务2个接口。
292
- - 提交训练写真模型任务:完成上传训练图片后,提交一个训练写真模型异步任务,根据写真模型 ID 开始训练模型。
295
+ """AI 写真分为上传训练图片、训练写真模型(可选跳过)、生成写真图片3个环节,需要依次调用对应接口。
296
+ 如果选择免训练模式无需调用本接口。
297
+ 训练模型分为提交任务和查询任务2个接口:
298
+ - 提交训练写真模型任务:完成上传图片后,提交一个训练写真模型异步任务,根据写真模型 ID 开始训练模型。
293
299
  - 查询训练写真模型任务:根据写真模型 ID 查询训练任务的处理状态、处理结果。
294
- 提交训练写真模型任务按并发任务数计费,无默认并发额度。
300
+
301
+ 每个写真模型自训练完成起1年内有效,有效期内可使用写真模型 ID 生成图片,期满后需要重新训练。
302
+ 提交训练写真模型任务按并发计费,无默认并发额度。
295
303
 
296
304
  :param request: Request instance for SubmitTrainPortraitModelJob.
297
305
  :type request: :class:`tencentcloud.aiart.v20221229.models.SubmitTrainPortraitModelJobRequest`
@@ -341,9 +349,14 @@ class AiartClient(AbstractClient):
341
349
 
342
350
 
343
351
  def UploadTrainPortraitImages(self, request):
344
- """AI 写真提供 AI 写真形象照的训练与生成能力,分为上传训练图片、训练模型、生成图片3个环节,需要依次调用对应接口。
345
- 本接口用于指定一个人物形象的写真模型 ID,上传用于训练该模型的图片。一个写真模型仅用于一个人物形象的写真生成,上传的训练图片要求所属同一人,建议上传单人、正脸、脸部区域占比较大、脸部清晰无遮挡、无大角度偏转、无夸张表情的图片。
346
- 上传写真训练图片默认提供1个并发任务数。
352
+ """AI 写真分为上传训练图片、训练写真模型(可选跳过)、生成写真图片3个环节,需要依次调用对应接口。
353
+ 本接口用于上传人像图片并指定对应的写真模型 ID。上传的图片要求是同一个人,建议上传单人、正脸、脸部区域占比较大、脸部清晰无遮挡、无大角度偏转、无夸张表情的图片。
354
+ 可选模式:
355
+ - 常规训练模式:上传20 - 25张图片用于模型训练,完成训练后可生成写真图片。
356
+ - 快速训练模式:仅需上传1张图片用于模型训练,训练速度更快,完成训练后可生成写真图片。
357
+ - 免训练模式:仅需上传1张图片,跳过训练环节,直接生成写真图片。
358
+
359
+ 上传写真训练图片默认提供1个并发。
347
360
 
348
361
  :param request: Request instance for UploadTrainPortraitImages.
349
362
  :type request: :class:`tencentcloud.aiart.v20221229.models.UploadTrainPortraitImagesRequest`
@@ -2044,21 +2044,21 @@ class UploadTrainPortraitImagesRequest(AbstractModel):
2044
2044
  图片限制:单边分辨率小于2000,转成 Base64 字符串后小于 5MB。
2045
2045
 
2046
2046
  :type BaseUrl: str
2047
- :param _Urls: 写真模型训练用的图像 URL 列表。
2047
+ :param _Urls: 写真模型训练用的图像 URL 列表,仅常规训练模式需要上传。
2048
2048
  图片数量:19 - 24 张。
2049
2049
  图片内容:单人,脸部清晰,和基础图像中的人物为同一人。
2050
2050
  图片限制:单边分辨率小于2000,转成 Base64 字符串后小于 5MB。
2051
-
2052
2051
  :type Urls: list of str
2053
2052
  :param _Filter: 训练图像质量过滤开关配置。
2054
2053
  支持开启或关闭对训练图像分辨率下限、脸部区域大小、脸部遮挡的过滤,默认开启以上过滤。
2055
2054
  如果训练图像内包含多人脸或无人脸、和 Base 人像不为同一人也将被过滤,不可关闭该过滤条件。
2056
2055
  建议:关闭以上过滤可能导致写真生成效果受损,建议使用单人、正脸、脸部区域占比较大、脸部清晰无遮挡、无大角度偏转、无夸张表情的图像进行训练。
2057
2056
  :type Filter: :class:`tencentcloud.aiart.v20221229.models.Filter`
2058
- :param _TrainMode: 是否开启快速训练模式。
2059
- 默认不开启。开启后只需要在 BaseUrl 中传入1张图片,Urls.N 中无需传入图片。
2060
- 0:不开启
2061
- 1:开启
2057
+ :param _TrainMode: 训练模式。
2058
+ 默认使用常规训练模式。如果使用快速训练模式和免训练模式,只需要在 BaseUrl 中传入1张图片,Urls.N 中无需传入图片。
2059
+ 0:常规训练模式,上传多张图片用于模型训练,完成训练后可生成写真图片。
2060
+ 1:快速训练模式,仅需上传1张图片用于模型训练,训练速度更快,完成训练后可生成写真图片。
2061
+ 2:免训练模式,仅需上传1张图片,跳过模型训练环节,直接生成写真图片。
2062
2062
  :type TrainMode: int
2063
2063
  """
2064
2064
  self._ModelId = None
@@ -4657,7 +4657,9 @@ class CwpClient(AbstractClient):
4657
4657
 
4658
4658
 
4659
4659
  def DescribeIndexList(self, request):
4660
- """获取索引列表
4660
+ """接口已废弃
4661
+
4662
+ 获取索引列表
4661
4663
 
4662
4664
  :param request: Request instance for DescribeIndexList.
4663
4665
  :type request: :class:`tencentcloud.cwp.v20180228.models.DescribeIndexListRequest`
@@ -151,6 +151,9 @@ class Acl(AbstractModel):
151
151
  :param _WhiteCmds: 关联的白命令命令
152
152
  注意:此字段可能返回 null,表示取不到有效值。
153
153
  :type WhiteCmds: list of str
154
+ :param _AllowKeyboardLogger: 是否允许记录键盘
155
+ 注意:此字段可能返回 null,表示取不到有效值。
156
+ :type AllowKeyboardLogger: bool
154
157
  """
155
158
  self._Id = None
156
159
  self._Name = None
@@ -182,6 +185,7 @@ class Acl(AbstractModel):
182
185
  self._AllowAccessCredential = None
183
186
  self._ACTemplateSet = None
184
187
  self._WhiteCmds = None
188
+ self._AllowKeyboardLogger = None
185
189
 
186
190
  @property
187
191
  def Id(self):
@@ -423,6 +427,14 @@ class Acl(AbstractModel):
423
427
  def WhiteCmds(self, WhiteCmds):
424
428
  self._WhiteCmds = WhiteCmds
425
429
 
430
+ @property
431
+ def AllowKeyboardLogger(self):
432
+ return self._AllowKeyboardLogger
433
+
434
+ @AllowKeyboardLogger.setter
435
+ def AllowKeyboardLogger(self, AllowKeyboardLogger):
436
+ self._AllowKeyboardLogger = AllowKeyboardLogger
437
+
426
438
 
427
439
  def _deserialize(self, params):
428
440
  self._Id = params.get("Id")
@@ -487,6 +499,7 @@ class Acl(AbstractModel):
487
499
  obj._deserialize(item)
488
500
  self._ACTemplateSet.append(obj)
489
501
  self._WhiteCmds = params.get("WhiteCmds")
502
+ self._AllowKeyboardLogger = params.get("AllowKeyboardLogger")
490
503
  memeber_set = set(params.keys())
491
504
  for name, value in vars(self).items():
492
505
  property_name = name[1:]
@@ -1839,6 +1852,8 @@ class CreateAclRequest(AbstractModel):
1839
1852
  :type DepartmentId: str
1840
1853
  :param _AllowAccessCredential: 是否允许使用访问串,默认允许
1841
1854
  :type AllowAccessCredential: bool
1855
+ :param _AllowKeyboardLogger: 是否允许记录键盘
1856
+ :type AllowKeyboardLogger: bool
1842
1857
  """
1843
1858
  self._Name = None
1844
1859
  self._AllowDiskRedirect = None
@@ -1867,6 +1882,7 @@ class CreateAclRequest(AbstractModel):
1867
1882
  self._ValidateTo = None
1868
1883
  self._DepartmentId = None
1869
1884
  self._AllowAccessCredential = None
1885
+ self._AllowKeyboardLogger = None
1870
1886
 
1871
1887
  @property
1872
1888
  def Name(self):
@@ -2084,6 +2100,14 @@ class CreateAclRequest(AbstractModel):
2084
2100
  def AllowAccessCredential(self, AllowAccessCredential):
2085
2101
  self._AllowAccessCredential = AllowAccessCredential
2086
2102
 
2103
+ @property
2104
+ def AllowKeyboardLogger(self):
2105
+ return self._AllowKeyboardLogger
2106
+
2107
+ @AllowKeyboardLogger.setter
2108
+ def AllowKeyboardLogger(self, AllowKeyboardLogger):
2109
+ self._AllowKeyboardLogger = AllowKeyboardLogger
2110
+
2087
2111
 
2088
2112
  def _deserialize(self, params):
2089
2113
  self._Name = params.get("Name")
@@ -2113,6 +2137,7 @@ class CreateAclRequest(AbstractModel):
2113
2137
  self._ValidateTo = params.get("ValidateTo")
2114
2138
  self._DepartmentId = params.get("DepartmentId")
2115
2139
  self._AllowAccessCredential = params.get("AllowAccessCredential")
2140
+ self._AllowKeyboardLogger = params.get("AllowKeyboardLogger")
2116
2141
  memeber_set = set(params.keys())
2117
2142
  for name, value in vars(self).items():
2118
2143
  property_name = name[1:]
@@ -7544,6 +7569,8 @@ class ModifyAclRequest(AbstractModel):
7544
7569
  :type DepartmentId: str
7545
7570
  :param _AllowAccessCredential: 是否允许使用访问串
7546
7571
  :type AllowAccessCredential: bool
7572
+ :param _AllowKeyboardLogger: 是否允许键盘记录
7573
+ :type AllowKeyboardLogger: bool
7547
7574
  """
7548
7575
  self._Name = None
7549
7576
  self._AllowDiskRedirect = None
@@ -7573,6 +7600,7 @@ class ModifyAclRequest(AbstractModel):
7573
7600
  self._ValidateTo = None
7574
7601
  self._DepartmentId = None
7575
7602
  self._AllowAccessCredential = None
7603
+ self._AllowKeyboardLogger = None
7576
7604
 
7577
7605
  @property
7578
7606
  def Name(self):
@@ -7798,6 +7826,14 @@ class ModifyAclRequest(AbstractModel):
7798
7826
  def AllowAccessCredential(self, AllowAccessCredential):
7799
7827
  self._AllowAccessCredential = AllowAccessCredential
7800
7828
 
7829
+ @property
7830
+ def AllowKeyboardLogger(self):
7831
+ return self._AllowKeyboardLogger
7832
+
7833
+ @AllowKeyboardLogger.setter
7834
+ def AllowKeyboardLogger(self, AllowKeyboardLogger):
7835
+ self._AllowKeyboardLogger = AllowKeyboardLogger
7836
+
7801
7837
 
7802
7838
  def _deserialize(self, params):
7803
7839
  self._Name = params.get("Name")
@@ -7828,6 +7864,7 @@ class ModifyAclRequest(AbstractModel):
7828
7864
  self._ValidateTo = params.get("ValidateTo")
7829
7865
  self._DepartmentId = params.get("DepartmentId")
7830
7866
  self._AllowAccessCredential = params.get("AllowAccessCredential")
7867
+ self._AllowKeyboardLogger = params.get("AllowKeyboardLogger")
7831
7868
  memeber_set = set(params.keys())
7832
7869
  for name, value in vars(self).items():
7833
7870
  property_name = name[1:]
@@ -1545,15 +1545,15 @@ class ConfigureSyncJobRequest(AbstractModel):
1545
1545
  :type ExpectRunTime: str
1546
1546
  :param _SrcConnectType: 源端tdsql连接方式:proxy-通过tdsql proxy主机访问各个set节点,注意只有在自研上云的网络环境下才能通过这种方式连接,SrcInfos中只需要提供proxy主机信息。set-直连set节点,如选择直连set方式,需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。
1547
1547
  :type SrcConnectType: str
1548
- :param _SrcInfo: 源端信息,单节点数据库使用,且SrcNodeType传single
1548
+ :param _SrcInfo: 源端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
1549
1549
  :type SrcInfo: :class:`tencentcloud.dts.v20211206.models.Endpoint`
1550
- :param _SrcInfos: 源端信息,多节点数据库使用,且SrcNodeType传cluster
1550
+ :param _SrcInfos: 源端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
1551
1551
  :type SrcInfos: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
1552
1552
  :param _SrcNodeType: 枚举值:cluster、single。源库为单节点数据库使用single,多节点使用cluster
1553
1553
  :type SrcNodeType: str
1554
- :param _DstInfo: 目标端信息,单节点数据库使用
1554
+ :param _DstInfo: 目标端信息,单机版类型数据库配置使用,且SrcNodeType传single。例如mysql、percona、mariadb等。
1555
1555
  :type DstInfo: :class:`tencentcloud.dts.v20211206.models.Endpoint`
1556
- :param _DstInfos: 目标端信息,多节点数据库使用,且DstNodeType传cluster
1556
+ :param _DstInfos: 目标端信息,分布式类型数据库配置使用,且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等。
1557
1557
  :type DstInfos: :class:`tencentcloud.dts.v20211206.models.SyncDBEndpointInfos`
1558
1558
  :param _DstNodeType: 枚举值:cluster、single。目标库为单节点数据库使用single,多节点使用cluster
1559
1559
  :type DstNodeType: str
@@ -65,7 +65,7 @@ class EssClient(AbstractClient):
65
65
 
66
66
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
67
67
 
68
- 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
68
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
69
69
 
70
70
  :param request: Request instance for CancelFlow.
71
71
  :type request: :class:`tencentcloud.ess.v20201111.models.CancelFlowRequest`
@@ -158,6 +158,8 @@ class EssClient(AbstractClient):
158
158
 
159
159
  3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
160
160
 
161
+ 4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
162
+
161
163
  :param request: Request instance for CreateBatchCancelFlowUrl.
162
164
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateBatchCancelFlowUrlRequest`
163
165
  :rtype: :class:`tencentcloud.ess.v20201111.models.CreateBatchCancelFlowUrlResponse`
@@ -285,10 +287,9 @@ class EssClient(AbstractClient):
285
287
  """该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
286
288
  **注意:**
287
289
  1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
288
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
289
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
290
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
291
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
290
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
291
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
292
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
292
293
  跳转到小程序的实现,参考微信官方文档(分为<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>。
293
294
  6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
294
295
 
@@ -377,7 +378,7 @@ class EssClient(AbstractClient):
377
378
  ### 调用流程
378
379
  该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
379
380
 
380
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
381
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
381
382
 
382
383
 
383
384
  ### 填充模板中定义的填写控件
@@ -561,7 +562,7 @@ class EssClient(AbstractClient):
561
562
 
562
563
  注:配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
563
564
 
564
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
565
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
565
566
 
566
567
  注:**静默(自动)签署不支持合同签署方存在填写**功能
567
568
  <br>
@@ -1504,6 +1505,8 @@ class EssClient(AbstractClient):
1504
1505
  <li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>
1505
1506
  </ul>
1506
1507
 
1508
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)
1509
+
1507
1510
  :param request: Request instance for CreateReleaseFlow.
1508
1511
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowRequest`
1509
1512
  :rtype: :class:`tencentcloud.ess.v20201111.models.CreateReleaseFlowResponse`
@@ -2094,7 +2097,12 @@ class EssClient(AbstractClient):
2094
2097
 
2095
2098
 
2096
2099
  def DescribeFlowComponents(self, request):
2097
- """可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。
2100
+ """可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
2101
+
2102
+
2103
+ 如下图模板所示,发起后对方填写后,可以获取红框中用户填写的信息。
2104
+
2105
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
2098
2106
 
2099
2107
  :param request: Request instance for DescribeFlowComponents.
2100
2108
  :type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowComponentsRequest`
@@ -2731,7 +2739,7 @@ class EssClient(AbstractClient):
2731
2739
  """此接口用于启动流程。它是模板发起合同的最后一步。
2732
2740
  在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
2733
2741
 
2734
- ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
2742
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
2735
2743
 
2736
2744
  注:
2737
2745
  1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
@@ -233,12 +233,15 @@ class ApproverInfo(AbstractModel):
233
233
  <li> 企业印章</li>
234
234
  <li> 骑缝章等签署控件</li></ul>
235
235
  :type SignComponents: list of Component
236
- :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
236
+ :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
237
237
  <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
238
238
  <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
239
239
  <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
240
240
  <li>OTHER_CARD_TYPE 其他证件</li></ul>
241
241
 
242
+
243
+
244
+
242
245
  注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
243
246
  :type ApproverIdCardType: str
244
247
  :param _ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
@@ -253,7 +256,7 @@ class ApproverInfo(AbstractModel):
253
256
  注意:
254
257
  `如果使用的是通过文件发起合同(CreateFlowByFiles),NotifyType必须 是 sms 才会发送短信`
255
258
  :type NotifyType: str
256
- :param _ApproverRole: 收据场景设置签署人角色类型, 可以设置如下****类型****:
259
+ :param _ApproverRole: 收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
257
260
  <ul><li> **1** :收款人</li>
258
261
  <li> **2** :开具人</li>
259
262
  <li> **3** :见证人</li></ul>
@@ -17645,11 +17648,14 @@ class FlowCreateApprover(AbstractModel):
17645
17648
 
17646
17649
  注: `若不设置此参数,则默认使用合同的截止时间,此参数暂不支持合同组子合同`
17647
17650
  :type Deadline: int
17648
- :param _Intention: 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
17651
+ :param _Intention: <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。
17649
17652
 
17650
- 注:
17651
- `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
17652
- `2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
17653
+ 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
17654
+
17655
+ 注意:
17656
+ 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
17657
+ 2. 使用视频认证时,<b>合同发起的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
17658
+ 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
17653
17659
  :type Intention: :class:`tencentcloud.ess.v20201111.models.Intention`
17654
17660
  """
17655
17661
  self._ApproverType = None
@@ -41,6 +41,7 @@ class EssbasicClient(AbstractClient):
41
41
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
42
42
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
43
43
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
44
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
44
45
 
45
46
  :param request: Request instance for ChannelBatchCancelFlows.
46
47
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelBatchCancelFlowsRequest`
@@ -74,6 +75,7 @@ class EssbasicClient(AbstractClient):
74
75
  - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
75
76
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
76
77
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
78
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
77
79
 
78
80
  :param request: Request instance for ChannelCancelFlow.
79
81
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCancelFlowRequest`
@@ -156,6 +158,7 @@ class EssbasicClient(AbstractClient):
156
158
  注:
157
159
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
158
160
  - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
161
+ - 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员, 其他参与人员看不到合同的内容。
159
162
 
160
163
  :param request: Request instance for ChannelCreateBatchCancelFlowUrl.
161
164
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchCancelFlowUrlRequest`
@@ -178,15 +181,14 @@ class EssbasicClient(AbstractClient):
178
181
 
179
182
 
180
183
  def ChannelCreateBatchQuickSignUrl(self, request):
181
- """该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
182
- **注意**:
183
- 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。
184
- 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件**
185
- 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
186
- 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
187
- 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
184
+ """该接口用于发起合同后,生成个人用户的批量待办链接, 暂时不支持企业端签署。
185
+ **注意:**
186
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
187
+ 2. 该接口可生成C端签署人的批量签署/查看链接,**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**
188
+ 3. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
189
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
188
190
  跳转到小程序的实现,参考微信官方文档(分为<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>。
189
- 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
191
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
190
192
 
191
193
  :param request: Request instance for ChannelCreateBatchQuickSignUrl.
192
194
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchQuickSignUrlRequest`
@@ -1710,7 +1712,7 @@ class EssbasicClient(AbstractClient):
1710
1712
  2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
1711
1713
 
1712
1714
  系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
1713
- ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
1715
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)
1714
1716
 
1715
1717
 
1716
1718
  <font color="red">相关视频指引</font> <br>
@@ -10309,6 +10309,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
10309
10309
  :type AutoJumpUrl: str
10310
10310
  :param _TopNavigationStatus: 是否展示头顶导航栏 <ul><li> **ENABLE** : (默认)进入web控制台展示头顶导航栏</li> <li> **DISABLE** : 进入web控制台不展示头顶导航栏</li></ul> 注:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
10311
10311
  :type TopNavigationStatus: str
10312
+ :param _AutoActive: 是否自动激活子客
10313
+ :type AutoActive: bool
10312
10314
  """
10313
10315
  self._Agent = None
10314
10316
  self._ProxyOrganizationName = None
@@ -10325,6 +10327,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
10325
10327
  self._ProxyOperatorIdCardNumber = None
10326
10328
  self._AutoJumpUrl = None
10327
10329
  self._TopNavigationStatus = None
10330
+ self._AutoActive = None
10328
10331
 
10329
10332
  @property
10330
10333
  def Agent(self):
@@ -10450,6 +10453,14 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
10450
10453
  def TopNavigationStatus(self, TopNavigationStatus):
10451
10454
  self._TopNavigationStatus = TopNavigationStatus
10452
10455
 
10456
+ @property
10457
+ def AutoActive(self):
10458
+ return self._AutoActive
10459
+
10460
+ @AutoActive.setter
10461
+ def AutoActive(self, AutoActive):
10462
+ self._AutoActive = AutoActive
10463
+
10453
10464
 
10454
10465
  def _deserialize(self, params):
10455
10466
  if params.get("Agent") is not None:
@@ -10471,6 +10482,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
10471
10482
  self._ProxyOperatorIdCardNumber = params.get("ProxyOperatorIdCardNumber")
10472
10483
  self._AutoJumpUrl = params.get("AutoJumpUrl")
10473
10484
  self._TopNavigationStatus = params.get("TopNavigationStatus")
10485
+ self._AutoActive = params.get("AutoActive")
10474
10486
  memeber_set = set(params.keys())
10475
10487
  for name, value in vars(self).items():
10476
10488
  property_name = name[1:]
@@ -14984,11 +14996,14 @@ class FlowApproverInfo(AbstractModel):
14984
14996
 
14985
14997
  注:`此参数仅在通过文件发起合同或者合同组时生效`
14986
14998
  :type Components: list of Component
14987
- :param _Intention: 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
14999
+ :param _Intention: <b>只有在生成H5签署链接的情形下</b>( 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口),该配置才会生效。
14988
15000
 
14989
- 注:
14990
- `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
14991
- `2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
15001
+ 您可以指定H5签署视频核身的意图配置,选择问答模式或点头模式的语音文本。
15002
+
15003
+ 注意:
15004
+ 1. 视频认证为<b>白名单功能,使用前请联系对接的客户经理沟通</b>。
15005
+ 2. 使用视频认证时,<b>合同发起的时候必须将签署认证方式指定为人脸</b>(即ApproverSignTypes设置成人脸签署)。
15006
+ 3. 签署完成后,可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
14992
15007
  :type Intention: :class:`tencentcloud.essbasic.v20210526.models.Intention`
14993
15008
  """
14994
15009
  self._Name = None