tencentcloud-sdk-python 3.0.1176__py2.py3-none-any.whl → 3.0.1179__py2.py3-none-any.whl

tencentcloud/ess/v20201111/ess_client.py

@@ -524,17 +524,17 @@ class EssClient(AbstractClient):
 
 
     def CreateFlowBlockchainEvidenceUrl(self, request):
-        """获取区块链存证报告查看链接/二维码接口
+        """获取区块链存证证书查看链接/二维码接口
 
-        适用场景：企业员工可以通过此接口生成合同区块链存证报告的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。
+        适用场景：企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。
 
-        [点击查看区块链存证报告样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
+        [点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
 
         注：
         <ul><li>1. 二维码下载链接过期时间为5分钟，请尽快下载保存。二维码/短链的过期时间为<font color="red">7天</font>，超过有效期则不可用。</li>
-        <li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成报告查看二维码/短链。</li>
+        <li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成证书查看二维码/短链。</li>
         <li>3. 调用接口时，需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>
-        <li>4. 通过扫码或者点击链接，用户无需登录或者鉴权即可查看对应合同的区块链存证报告，请妥善保管好二维码或链接。</li></ul>
+        <li>4. 通过扫码或者点击链接，用户无需登录或者鉴权即可查看对应合同的区块链存证证书，请妥善保管好二维码或链接。</li></ul>
 
         :param request: Request instance for CreateFlowBlockchainEvidenceUrl.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateFlowBlockchainEvidenceUrlRequest`
@@ -1025,10 +1025,15 @@ class EssClient(AbstractClient):
 
 
     def CreateLegalSealQrCode(self, request):
-        """该接口用于获取创建法人章的二维码<br/>
+        """该接口用于获取创建法人章的二维码，需要通过微信扫描。扫描后将跳转到腾讯电子签署，进入到创建法人章的流程。
 
         **注意**
         1. 该二维码**有效期为7天**，过期后将失效，可重新创建 。
+        2. 每个公司**只能有1个法人章**，无法重复创建或者创建多个
+
+        法人章的样式可以参考下图索引（也可以自己上传法人印章图片）：
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/36a0a090750c45bb5cac5047ac461b2c.png)
 
         :param request: Request instance for CreateLegalSealQrCode.
         :type request: :class:`tencentcloud.ess.v20201111.models.CreateLegalSealQrCodeRequest`
@@ -2122,8 +2127,10 @@ class EssClient(AbstractClient):
 
 
     def DescribeOrganizationSeals(self, request):
-        """查询企业印章的列表，需要操作者具有查询印章权限
-        客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
+        """查询企业印章列表。
+
+        注：
+        1. 此操作要求操作者具备<b>印章查询权限</b>（若调用者尚无此权限，请联系超级管理员前往Web控制台【组织管理】->【角色管理】添加相应权限）。
 
         :param request: Request instance for DescribeOrganizationSeals.
         :type request: :class:`tencentcloud.ess.v20201111.models.DescribeOrganizationSealsRequest`

tencentcloud/ess/v20201111/models.py

@@ -2015,8 +2015,6 @@ class Component(AbstractModel):
     1. 绝对定位方式 （可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标）
     2. 表单域(FIELD)定位方式
     3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
-    可以参考官网说明
-    https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
 
     """
 
@@ -2032,6 +2030,7 @@ class Component(AbstractModel):
 <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>
 <li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>
 <li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>
+<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>
 <li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>
 
 **如果是SignComponent签署控件类型，
@@ -2120,6 +2119,14 @@ class Component(AbstractModel):
 <li> <b>FontSize</b>： 范围12 :72</li></ul>
 <b>参数样例</b>：`{"FontColor":"255,0,0","FontSize":12}`
 
+<font color="red">ComponentType为WATERMARK时</font>，支持以下参数：
+<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>
+<li> <b>FontSize</b>： 范围6 :24</li>
+<li> <b>Opacity</b>： 透明度，范围0 :1</li>
+<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>
+<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>
+<b>参数样例</b>：`"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"`
+
 <font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：
 <ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>
 <li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>
@@ -4225,7 +4232,7 @@ class CreateFlowBlockchainEvidenceUrlResponse(AbstractModel):
         r"""
         :param _QrCode: 二维码图片下载链接，下载链接有效时间5分钟，请尽快下载保存。
         :type QrCode: str
-        :param _Url: 查看短链，可直接点击短链查看报告。
+        :param _Url: 查看短链，可直接点击短链查看证书。
         :type Url: str
         :param _ExpiredOn: 二维码和短链的过期时间戳，过期时间默认为生成链接后7天。
         :type ExpiredOn: int
@@ -7107,7 +7114,10 @@ class CreateLegalSealQrCodeResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _QrcodeBase64: 二维码图片base64值
+        :param _QrcodeBase64: 二维码图片base64值，二维码有效期7天（604800秒）
+
+二维码图片的样式如下图：
+![image](https://qcloudimg.tencent-cloud.cn/raw/7ec2478761158a35a9c623882839a5df.png)
         :type QrcodeBase64: str
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str
@@ -14161,38 +14171,32 @@ class DescribeOrganizationSealsRequest(AbstractModel):
         :type Limit: int
         :param _Offset: 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0，最大 20000。
         :type Offset: int
-        :param _InfoType: 查询信息类型，取值如下：
-<ul>
-<li>0不返回授权用户</li>
-<li>1返回授权用户信息</li>
-</ul>
+        :param _InfoType: 查询授权用户信息类型，取值如下：
+
+<ul> <li><b>0</b>：（默认）不返回授权用户信息</li> <li><b>1</b>：返回授权用户的信息</li> </ul>
         :type InfoType: int
-        :param _SealId: 印章id（没有输入返回所有）
+        :param _SealId: 印章id，是否查询特定的印章（没有输入返回所有）
         :type SealId: str
-        :param _SealTypes: 印章类型列表（都是组织机构印章）。
-为空时查询所有类型的印章。
-目前支持以下类型：
-<ul>
-<li>OFFICIAL：企业公章；</li>
-<li>CONTRACT：合同专用章；</li>
-<li>ORGANIZATION_SEAL：企业印章(图片上传创建)；</li>
-<li>LEGAL_PERSON_SEAL：法定代表人章</li>
-</ul>
+        :param _SealTypes: 印章种类列表（均为组织机构印章）。 若无特定需求，将展示所有类型的印章。 
+
+目前支持以下几种：
+
+<ul> <li><strong>OFFICIAL</strong>：企业公章；</li> <li><strong>CONTRACT</strong>：合同专用章；</li> <li><strong>ORGANIZATION_SEAL</strong>：企业印章（通过图片上传创建）；</li> <li><strong>LEGAL_PERSON_SEAL</strong>：法定代表人章。</li> </ul>
         :type SealTypes: list of str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
-        :param _SealStatuses: 查询的印章状态列表。
+        :param _SealStatuses: 需查询的印章状态列表。
 <ul>
-<li>空，只查询启用状态的印章；</li>
-<li>ALL，查询所有状态的印章；</li>
-<li>CHECKING，查询待审核的印章；</li>
-<li>SUCCESS，查询启用状态的印章；</li>
-<li>FAIL，查询印章审核拒绝的印章；</li>
-<li>DISABLE，查询已停用的印章；</li>
-<li>STOPPED，查询已终止的印章；</li>
-<li>VOID，查询已作废的印章；</li>
-<li>INVALID，查询已失效的印章；</li>
+<li>空：（默认）仅查询启用状态的印章；</li>
+<li><strong>ALL</strong>：查询所有状态的印章；</li>
+<li><strong>CHECKING</strong>：查询待审核的印章；</li>
+<li><strong>SUCCESS</strong>：查询启用状态的印章；</li>
+<li><strong>FAIL</strong>：查询印章审核拒绝的印章；</li>
+<li><strong>DISABLE</strong>：查询已停用的印章；</li>
+<li><strong>STOPPED</strong>：查询已终止的印章；</li>
+<li><strong>VOID</strong>：查询已作废的印章；</li>
+<li><strong>INVALID</strong>：查询已失效的印章。</li>
 </ul>
         :type SealStatuses: list of str
         """
@@ -14300,7 +14304,7 @@ class DescribeOrganizationSealsResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _TotalCount: 在设置了SealId时返回0或1，没有设置时返回公司的总印章数量，可能比返回的印章数组数量多
+        :param _TotalCount: 在设定了SealId时，返回值为0或1；若未设定SealId，则返回公司的总印章数量
         :type TotalCount: int
         :param _Seals: 查询到的印章结果数组
         :type Seals: list of OccupiedSeal

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -1218,11 +1218,10 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelDescribeOrganizationSeals(self, request):
-        """此接口（ChannelDescribeOrganizationSeals）查询子客企业电子印章。<br />
-        注:
-        1. `查询子客企业电子印章，需要操作者具有管理印章权限`
-        2. `客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理`
-        3. `此接口只能查询启用的印章`
+        """此接口查询子企业电子印章。<br />
+
+        注：
+        1. 此操作要求操作者具备<b>印章查询权限</b>（若调用者尚无此权限，请联系超级管理员前往Web控制台【组织管理】->【角色管理】添加相应权限）。
 
         :param request: Request instance for ChannelDescribeOrganizationSeals.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeOrganizationSealsRequest`
@@ -1693,17 +1692,17 @@ class EssbasicClient(AbstractClient):
 
 
     def CreateFlowBlockchainEvidenceUrl(self, request):
-        """获取区块链存证报告查看链接/二维码接口
+        """获取区块链存证证书查看链接/二维码接口
 
-        适用场景：企业员工可以通过此接口生成合同区块链存证报告的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。
+        适用场景：企业员工可以通过此接口生成合同区块链存证证书的查看链接/二维码，以供他人扫码打开腾讯电子签小程序查看。
 
-        [点击查看区块链存证报告样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
+        [点击查看区块链存证证书样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
 
         注：
         <ul><li>1. 二维码下载链接过期时间为5分钟，请尽快下载保存。二维码/短链的过期时间为<font color="red">7天</font>，超过有效期则不可用。</li>
-        <li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成报告查看二维码/短链。</li>
+        <li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成证书查看二维码/短链。</li>
         <li>3. 调用接口时，需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>
-        <li>4. 通过扫码或者点击链接，用户无需登录或者鉴权即可查看对应合同的区块链存证报告，请妥善保管好二维码或链接。</li></ul>
+        <li>4. 通过扫码或者点击链接，用户无需登录或者鉴权即可查看对应合同的区块链存证证书，请妥善保管好二维码或链接。</li></ul>
 
         :param request: Request instance for CreateFlowBlockchainEvidenceUrl.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowBlockchainEvidenceUrlRequest`
@@ -1840,7 +1839,15 @@ class EssbasicClient(AbstractClient):
 
 
     def CreateLegalSealQrCode(self, request):
-        """此接口用于获取创建法人章二维码图片base64
+        """该接口用于获取创建法人章的二维码，需要通过微信扫描。扫描后将跳转到腾讯电子签署，进入到创建法人章的流程。
+
+        **注意**
+        1. 该二维码**有效期为7天**，过期后将失效，可重新创建 。
+        2. 每个公司**只能有1个法人章**，无法重复创建或者创建多个
+
+        法人章的样式可以参考下图索引（也可以自己上传法人印章图片）：
+
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/36a0a090750c45bb5cac5047ac461b2c.png)
 
         :param request: Request instance for CreateLegalSealQrCode.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateLegalSealQrCodeRequest`

tencentcloud/essbasic/v20210526/models.py

@@ -6974,22 +6974,20 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
 </ul>
 第三方平台子客企业和员工必须已经经过实名认证
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
-        :param _Limit: 返回最大数量，最大为100
+        :param _Limit: 指定分页每页返回的数据条数，单页最大支持 100。
         :type Limit: int
         :param _Offset: 分页查询偏移量，默认为0，最大为20000
         :type Offset: int
-        :param _InfoType: 查询信息类型
-支持的值如下：
-<ul><li>0-默认，不返回授权用户信息</li>
-<li>1-返回授权用户信息</li>
-</ul>
+        :param _InfoType: 查询授权用户信息类型，取值如下：
+
+<ul> <li><b>0</b>：（默认）不返回授权用户信息</li> <li><b>1</b>：返回授权用户的信息</li> </ul>
         :type InfoType: int
-        :param _SealId: 印章id（没有输入返回所有）
+        :param _SealId: 印章id，是否查询特定的印章（没有输入返回所有）
 
 注:  `没有输入返回所有记录，最大返回100条。`
         :type SealId: str
         :param _SealTypes: 电子印章类型 , 可选类型如下: 
-<ul><li>**OFFICIAL**: (默认)公章</li>
+<ul><li>**OFFICIAL**: 公章</li>
 <li>**CONTRACT**: 合同专用章;</li>
 <li>**FINANCE**: 财务专用章;</li>
 <li>**PERSONNEL**: 人事专用章</li>
@@ -6998,7 +6996,10 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
 
 注:  `为空时查询所有类型的印章。`
         :type SealTypes: list of str
-        :param _SealStatuses: 查询的印章状态列表。 <ul> <li>空，只查询启用状态的印章；</li> <li>ALL，查询所有状态的印章；</li> <li>CHECKING，查询待审核的印章；</li> <li>SUCCESS，查询启用状态的印章；</li> <li>FAIL，查询印章审核拒绝的印章；</li> <li>DISABLE，查询已停用的印章；</li> <li>STOPPED，查询已终止的印章；</li> <li>VOID，查询已作废的印章；</li> <li>INVALID，查询已失效的印章；</li> </ul>
+        :param _SealStatuses: 
+需查询的印章状态列表。
+
+<ul> <li>空，()仅查询启用状态的印章；</li> <li><strong>ALL</strong>，查询所有状态的印章；</li> <li><strong>CHECKING</strong>，查询待审核的印章；</li> <li><strong>SUCCESS</strong>，查询启用状态的印章；</li> <li><strong>FAIL</strong>，查询印章审核拒绝的印章；</li> <li><strong>DISABLE</strong>，查询已停用的印章；</li> <li><strong>STOPPED</strong>，查询已终止的印章；</li> <li><strong>VOID</strong>，查询已作废的印章；</li> <li><strong>INVALID</strong>，查询已失效的印章。</li> </ul>
         :type SealStatuses: list of str
         """
         self._Agent = None
@@ -7093,7 +7094,7 @@ class ChannelDescribeOrganizationSealsResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _TotalCount: 在设置了SealId时返回0或1，没有设置时返回公司的总印章数量，可能比返回的印章数组数量多
+        :param _TotalCount: 在设定了SealId时，返回值为0或1；若未设定SealId，则返回公司的总印章数量
         :type TotalCount: int
         :param _Seals: 查询到的印章结果数组
         :type Seals: list of OccupiedSeal
@@ -9028,8 +9029,6 @@ class Component(AbstractModel):
     1. 绝对定位方式 （可以通过 [PDF坐标计算助手](https://qian.tencent.com/developers/tools/template-editor)计算控件的坐标）
     2. 表单域(FIELD)定位方式
     3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
-    可以参考官网说明
-    https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
 
     """
 
@@ -10024,7 +10023,8 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
 `3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
         :param _ProxyOrganizationName: 第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。
-<font color="red">在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。</font>
+<font color="red">在测试环境联调的过程中，企业名称请使用以下名称 
+**子客测试专用企业1 - 子客测试专用企业9**</font>
 
 注:
  `1. 如果名称中包含英文括号()，请使用中文括号（）代替。`
@@ -10396,7 +10396,7 @@ class CreateFlowBlockchainEvidenceUrlResponse(AbstractModel):
         r"""
         :param _QrCode: 二维码图片下载链接，下载链接有效时间5分钟，请尽快下载保存。
         :type QrCode: str
-        :param _Url: 查看短链，可直接点击短链查看报告。
+        :param _Url: 查看短链，可直接点击短链查看证书。
         :type Url: str
         :param _ExpiredOn: 二维码和短链的过期时间戳，过期时间默认为生成链接后7天。
         :type ExpiredOn: int
@@ -11026,7 +11026,10 @@ class CreateLegalSealQrCodeResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _QrcodeBase64: 二维码图片base64值
+        :param _QrcodeBase64: 二维码图片base64值，二维码有效期7天（604800秒）
+
+二维码图片的样式如下图：
+![image](https://qcloudimg.tencent-cloud.cn/raw/7ec2478761158a35a9c623882839a5df.png)
         :type QrcodeBase64: str
         :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         :type RequestId: str

tencentcloud/ims/v20201229/ims_client.py

@@ -41,7 +41,7 @@ class ImsClient(AbstractClient):
         - 支持用户自定义选择图片风险库，打击自定义识别类型的违规图片（目前仅支持黑名单配置）；
         - 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。
         ### 接口调用说明：
-        - 图片文件大小支持：**文件<100M**
+        - 图片文件大小限制：**Base64编码内容应小于10MB**；**图片资源应小于100MB**
         - 图片尺寸支持：**长和宽 需>50分辨率且<40000分辨率，并且图片长宽比<90:1；**
         - 图片文件分辨率支持：建议**分辨率大于256x256**，否则可能会影响识别效果；
         - 图片文件支持格式：PNG、JPG、JPEG、BMP、GIF、WEBP格式；
@@ -85,7 +85,7 @@ class ImsClient(AbstractClient):
         - 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。
 
         ### 接口调用说明：
-        - 图片文件大小支持：**文件 < 30M**
+        - 图片文件大小限制：**Base64编码内容应小于10MB**；**URL资源应小于30MB**
         - 图片默认尺寸支持：**长和宽 需>50分辨率且<10000分辨率，并且图片长宽比<90:1；**
         - 图片文件分辨率支持：建议**分辨率大于256x256**，否则可能会影响识别效果；
         - 图片文件支持格式：PNG、JPG、JPEG、BMP、GIF、WEBP格式；