tencentcloud-sdk-python 3.0.1238__py2.py3-none-any.whl → 3.0.1241__py2.py3-none-any.whl

tencentcloud/ess/v20201111/models.py

@@ -233,12 +233,15 @@ class ApproverInfo(AbstractModel):
 <li> 企业印章</li>
 <li> 骑缝章等签署控件</li></ul>
         :type SignComponents: list of Component
-        :param _ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
+        :param _ApproverIdCardType: 签署方经办人的证件类型，支持以下类型，样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
 <ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li>
 <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
 <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
 <li>OTHER_CARD_TYPE 其他证件</li></ul>
 
+
+
+
 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
         :type ApproverIdCardType: str
         :param _ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
@@ -253,7 +256,7 @@ class ApproverInfo(AbstractModel):
 注意：
 `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`
         :type NotifyType: str
-        :param _ApproverRole: 收据场景设置签署人角色类型, 可以设置如下****类型****:
+        :param _ApproverRole: 收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
 <ul><li> **1**  :收款人</li>
 <li>   **2**   :开具人</li>
 <li>   **3** :见证人</li></ul>
@@ -6782,9 +6785,10 @@ class CreateFlowSignUrlRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _FlowId: 合同流程ID，为32位字符串。
-建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
-可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        :param _FlowId: 合同流程ID为32位字符串。
+
+您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
+
         :type FlowId: str
         :param _Operator: 执行本接口操作的员工信息。
 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
@@ -6792,23 +6796,27 @@ class CreateFlowSignUrlRequest(AbstractModel):
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
-        :param _FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。
+        :param _FlowApproverInfos: 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
+
+注：
+1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。
+2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
+
 
-注:
-`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
-`2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
         :type FlowApproverInfos: list of FlowCreateApprover
         :param _Organization: 机构信息，暂未开放
         :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
         :param _JumpUrl: 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
 
         :type JumpUrl: str
-        :param _UrlType: 链接类型，支持指定以下类型
-<ul><li>0 : 签署链接 (默认值)</li>
-<li>1 : 预览链接</li></ul>
-注:
-`1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。`
-`2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`
+        :param _UrlType: 链接类型支持以下指定类型：
+
+<ul><li><b>0</b>: 签署链接（默认值），进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接，进入后可以预览合同当前的样子。</li></ul>
+
+注：
+
+1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
+2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
         :type UrlType: int
         """
         self._FlowId = None
@@ -13455,11 +13463,10 @@ class DescribeFlowBriefsRequest(AbstractModel):
 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
         :param _FlowIds: 查询的合同流程ID列表最多支持100个流程ID。 
-如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
 
-可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
 
-[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
+可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         :type FlowIds: list of str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -17645,11 +17652,14 @@ class FlowCreateApprover(AbstractModel):
 
 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
         :type Deadline: int
-        :param _Intention: 视频核身意图配置，可指定问答模式或者点头模式的语音文本。
+        :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>等接口），该配置才会生效。
 
-注:
- `1.视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
-`2.使用视频认证必须指定签署认证方式为人脸（即ApproverSignTypes）。`
+您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
+
+注意：
+1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。
+2. 使用视频认证时，<b>生成H5签署链接必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。
+3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
         :type Intention: :class:`tencentcloud.ess.v20201111.models.Intention`
         """
         self._ApproverType = None

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -41,6 +41,7 @@ class EssbasicClient(AbstractClient):
         - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
         - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
         - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
+        - 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
 
         :param request: Request instance for ChannelBatchCancelFlows.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelBatchCancelFlowsRequest`
@@ -74,6 +75,7 @@ class EssbasicClient(AbstractClient):
         - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
         - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
         - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
+        - 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
 
         :param request: Request instance for ChannelCancelFlow.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCancelFlowRequest`
@@ -156,6 +158,7 @@ class EssbasicClient(AbstractClient):
         注:
         - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
         - <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
+        - 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
 
         :param request: Request instance for ChannelCreateBatchCancelFlowUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchCancelFlowUrlRequest`
@@ -178,15 +181,14 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelCreateBatchQuickSignUrl(self, request):
-        """该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。
-        **注意**：
-        1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。
-        2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**，**不支持填写控件** 。
-        3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。
-        4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
-        5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
+        """该接口用于发起合同后，生成个人用户的批量待办链接, 暂时不支持企业端签署。
+        **注意：**
+        1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
+        2. 该接口可生成C端签署人的批量签署/查看链接，**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件** 。
+        3. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
+        4. 该接口返回的签署链接适用于APP集成的场景，支持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>。
-        6.  因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
+        6. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
 
         :param request: Request instance for ChannelCreateBatchQuickSignUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchQuickSignUrlRequest`
@@ -1710,7 +1712,7 @@ class EssbasicClient(AbstractClient):
         2. 若您认证中发现信息有误需要重新认证，**可通过更换用户OpenID重新生成链接的方式，来清理掉已有的流程**。
 
         系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
-        ![image](https://qcloudimg.tencent-cloud.cn/raw/bee4b7375fe7a097f3573b18a1c1e30b.png)
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/77677faeea26c9d7f37474597c81fe01.png)
 
 
         <font color="red">相关视频指引</font> <br>

tencentcloud/essbasic/v20210526/models.py

@@ -10309,6 +10309,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
         :type AutoJumpUrl: str
         :param _TopNavigationStatus: 是否展示头顶导航栏  <ul><li> **ENABLE** : (默认)进入web控制台展示头顶导航栏</li> <li> **DISABLE** : 进入web控制台不展示头顶导航栏</li></ul> 注：该参数**仅在企业和员工激活完成，登录控制台场景才生效**。
         :type TopNavigationStatus: str
+        :param _AutoActive: 是否自动激活子客
+        :type AutoActive: bool
         """
         self._Agent = None
         self._ProxyOrganizationName = None
@@ -10325,6 +10327,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
         self._ProxyOperatorIdCardNumber = None
         self._AutoJumpUrl = None
         self._TopNavigationStatus = None
+        self._AutoActive = None
 
     @property
     def Agent(self):
@@ -10450,6 +10453,14 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
     def TopNavigationStatus(self, TopNavigationStatus):
         self._TopNavigationStatus = TopNavigationStatus
 
+    @property
+    def AutoActive(self):
+        return self._AutoActive
+
+    @AutoActive.setter
+    def AutoActive(self, AutoActive):
+        self._AutoActive = AutoActive
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -10471,6 +10482,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
         self._ProxyOperatorIdCardNumber = params.get("ProxyOperatorIdCardNumber")
         self._AutoJumpUrl = params.get("AutoJumpUrl")
         self._TopNavigationStatus = params.get("TopNavigationStatus")
+        self._AutoActive = params.get("AutoActive")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -14984,11 +14996,14 @@ class FlowApproverInfo(AbstractModel):
 
 注：`此参数仅在通过文件发起合同或者合同组时生效`
         :type Components: list of Component
-        :param _Intention: 视频核身意图配置，可指定问答模式或者点头模式的语音文本。
+        :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>等接口），该配置才会生效。
 
-注:
- `1.视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
-`2.使用视频认证必须指定签署认证方式为人脸（即ApproverSignTypes）。`
+您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
+
+注意：
+1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。
+2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。
+3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
         :type Intention: :class:`tencentcloud.essbasic.v20210526.models.Intention`
         """
         self._Name = None

tencentcloud/faceid/v20180301/models.py

@@ -3751,6 +3751,8 @@ class GetEidTokenConfig(AbstractModel):
         :type IsSupportHMTResidentPermitOCR: bool
         :param _MouthOpenRecognition: 用户语音回答过程中是否开启张嘴识别检测，默认不开启，仅在意愿核身问答模式中使用。
         :type MouthOpenRecognition: bool
+        :param _Speed: 意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0： 0：智能语速（根据播报文案的长度自动调整语音播报速度） 1：固定1倍速 2：固定1.2倍速 3：固定1.5倍速
+        :type Speed: int
         """
         self._InputType = None
         self._UseIntentionVerify = None
@@ -3761,6 +3763,7 @@ class GetEidTokenConfig(AbstractModel):
         self._IntentionRecognition = None
         self._IsSupportHMTResidentPermitOCR = None
         self._MouthOpenRecognition = None
+        self._Speed = None
 
     @property
     def InputType(self):
@@ -3834,6 +3837,14 @@ class GetEidTokenConfig(AbstractModel):
     def MouthOpenRecognition(self, MouthOpenRecognition):
         self._MouthOpenRecognition = MouthOpenRecognition
 
+    @property
+    def Speed(self):
+        return self._Speed
+
+    @Speed.setter
+    def Speed(self, Speed):
+        self._Speed = Speed
+
 
     def _deserialize(self, params):
         self._InputType = params.get("InputType")
@@ -3855,6 +3866,7 @@ class GetEidTokenConfig(AbstractModel):
         self._IntentionRecognition = params.get("IntentionRecognition")
         self._IsSupportHMTResidentPermitOCR = params.get("IsSupportHMTResidentPermitOCR")
         self._MouthOpenRecognition = params.get("MouthOpenRecognition")
+        self._Speed = params.get("Speed")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]