tencentcloud-sdk-python-essbasic 3.0.1167__tar.gz → 3.0.1172__tar.gz

{tencentcloud-sdk-python-essbasic-3.0.1167 → tencentcloud-sdk-python-essbasic-3.0.1172}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1167
+Version: 3.0.1172
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

{tencentcloud-sdk-python-essbasic-3.0.1167 → tencentcloud-sdk-python-essbasic-3.0.1172}/setup.py

@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
 
 setup(
     name='tencentcloud-sdk-python-essbasic',
-    install_requires=["tencentcloud-sdk-python-common==3.0.1167"],
+    install_requires=["tencentcloud-sdk-python-common==3.0.1172"],
     version=tencentcloud.__version__,
     description='Tencent Cloud Essbasic SDK for Python',
     long_description=open('README.rst').read(),

{tencentcloud-sdk-python-essbasic-3.0.1167 → tencentcloud-sdk-python-essbasic-3.0.1172}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1167'
+__version__ = '3.0.1172'

{tencentcloud-sdk-python-essbasic-3.0.1167 → tencentcloud-sdk-python-essbasic-3.0.1172}/tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -396,6 +396,10 @@ class EssbasicClient(AbstractClient):
 
         `4. 静默（自动）签署不支持合同签署方存在填写功能`
 
+        <font color="red">相关视频指引</font> <br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a><br>
+
         :param request: Request instance for ChannelCreateFlowByFiles.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowByFilesRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowByFilesResponse`
@@ -664,8 +668,8 @@ class EssbasicClient(AbstractClient):
 
         **注意**
         1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
-        2. 该接口返回的签署链接适用于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>。
+        2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。配置方式请参考：<a href="https://qian.tencent.com/developers/company/openqianh5/">跳转电子签H5</a>。
+        如需跳转到小程序的实现，参考微信官方文档（分为<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>。
         3. 因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 ChannelCreateFlowSignUrl.
@@ -1777,6 +1781,10 @@ class EssbasicClient(AbstractClient):
 
         5.  <font color="red">在下一步创建签署链接前，建议等待DocumentFill </font> <a href="https://qian.tencent.com/developers/partner/callback_types_file_resources">PDF合成完成的回调</a>或者睡眠几秒，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
 
+
+        <font color="red">相关视频指引</font> <br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
+
         :param request: Request instance for CreateFlowsByTemplates.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesResponse`
@@ -2185,6 +2193,9 @@ class EssbasicClient(AbstractClient):
         >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。
         >2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准
 
+        <font color="red">相关视频指引</font> <br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-CreateTemplates.mp4" target="_blank">创建模板&设置成本企业自动签署</a><br>
+
         :param request: Request instance for DescribeTemplates.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeTemplatesRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeTemplatesResponse`
@@ -2486,6 +2497,9 @@ class EssbasicClient(AbstractClient):
         httpProfile.setEndpoint("file.test.ess.tencent.cn");
         ```
 
+        <font color="red">相关视频指引</font> <br>
+        1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
+
         :param request: Request instance for UploadFiles.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.UploadFilesResponse`

{tencentcloud-sdk-python-essbasic-3.0.1167 → tencentcloud-sdk-python-essbasic-3.0.1172}/tencentcloud/essbasic/v20210526/models.py

@@ -2635,6 +2635,8 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
 </li>
 </ul>
         :type UserData: str
+        :param _Option: 个性化参数，用于控制页面展示内容
+        :type Option: :class:`tencentcloud.essbasic.v20210526.models.EmbedUrlOption`
         """
         self._Agent = None
         self._EmbedType = None
@@ -2642,6 +2644,7 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
         self._HiddenComponents = None
         self._Operator = None
         self._UserData = None
+        self._Option = None
 
     @property
     def Agent(self):
@@ -2695,6 +2698,14 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
     def UserData(self, UserData):
         self._UserData = UserData
 
+    @property
+    def Option(self):
+        return self._Option
+
+    @Option.setter
+    def Option(self, Option):
+        self._Option = Option
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -2707,6 +2718,9 @@ class ChannelCreateEmbedWebUrlRequest(AbstractModel):
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
         self._UserData = params.get("UserData")
+        if params.get("Option") is not None:
+            self._Option = EmbedUrlOption()
+            self._Option._deserialize(params.get("Option"))
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -3917,14 +3931,15 @@ class ChannelCreateFlowSignUrlRequest(AbstractModel):
         :param _FlowApproverInfos: 流程签署人列表，其中结构体的Name，Mobile和ApproverType必传，企业签署人则还需传OrganizationName、OpenId、OrganizationOpenId，其他可不传。
 
 注:
-`1. 签署人只能有手写签名、时间类型和印章类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
+`1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
 `2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
         :type FlowApproverInfos: list of FlowApproverInfo
         :param _Operator: 用户信息，暂未开放
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
         :param _Organization: 机构信息，暂未开放
         :type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
-        :param _JumpUrl: 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
+        :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>
@@ -6981,6 +6996,8 @@ 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>
+        :type SealStatuses: list of str
         """
         self._Agent = None
         self._Limit = None
@@ -6988,6 +7005,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
         self._InfoType = None
         self._SealId = None
         self._SealTypes = None
+        self._SealStatuses = None
 
     @property
     def Agent(self):
@@ -7037,6 +7055,14 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
     def SealTypes(self, SealTypes):
         self._SealTypes = SealTypes
 
+    @property
+    def SealStatuses(self):
+        return self._SealStatuses
+
+    @SealStatuses.setter
+    def SealStatuses(self, SealStatuses):
+        self._SealStatuses = SealStatuses
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -7047,6 +7073,7 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
         self._InfoType = params.get("InfoType")
         self._SealId = params.get("SealId")
         self._SealTypes = params.get("SealTypes")
+        self._SealStatuses = params.get("SealStatuses")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -10831,11 +10858,19 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
  注：该参数需要开通“基于子客授权第三方应用可文件发起子客自动签署”，请联系运营经理开通
 
         :type PlatformAppAuthorization: bool
+        :param _SealTypes: 指定印章类型，指定后只能选择该类型的印章进行授权
+支持以下印章类型：
+- OFFICIAL : 企业公章
+- CONTRACT : 合同专用章
+- FINANCE : 财务专用章
+- PERSONNEL : 人事专用章
+        :type SealTypes: list of str
         """
         self._Agent = None
         self._AuthorizedOrganizationId = None
         self._AuthorizedOrganizationName = None
         self._PlatformAppAuthorization = None
+        self._SealTypes = None
 
     @property
     def Agent(self):
@@ -10869,6 +10904,14 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
     def PlatformAppAuthorization(self, PlatformAppAuthorization):
         self._PlatformAppAuthorization = PlatformAppAuthorization
 
+    @property
+    def SealTypes(self):
+        return self._SealTypes
+
+    @SealTypes.setter
+    def SealTypes(self, SealTypes):
+        self._SealTypes = SealTypes
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -10877,6 +10920,7 @@ class CreatePartnerAutoSignAuthUrlRequest(AbstractModel):
         self._AuthorizedOrganizationId = params.get("AuthorizedOrganizationId")
         self._AuthorizedOrganizationName = params.get("AuthorizedOrganizationName")
         self._PlatformAppAuthorization = params.get("PlatformAppAuthorization")
+        self._SealTypes = params.get("SealTypes")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -11010,8 +11054,12 @@ class CreateSealByImageRequest(AbstractModel):
 <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
         :type SealSize: str
         :param _TaxIdentifyCode: 企业税号
-注: `1.印章类型SealType是INVOICE类型时，此参数才会生效`
-`2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号`
+
+注:
+<ul>
+<li>1.印章类型SealType是INVOICE类型时，此参数才会生效</li>
+<li>2.印章类型SealType是INVOICE类型，且该字段没有传入值或传入空时，会取该企业对应的统一社会信用代码作为默认的企业税号（<font color="red">如果是通过授权书授权方式认证的企业，此参数必传不能为空</font>）</li>
+</ul>
         :type TaxIdentifyCode: str
         """
         self._Agent = None
@@ -13328,6 +13376,57 @@ class DownloadFlowInfo(AbstractModel):
         
 
 
+class EmbedUrlOption(AbstractModel):
+    """创建嵌入式页面url个性化参数
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _ShowFlowDetailComponent: 合同详情页面是否展示合同控件信息
+<br/>true:允许在合同详情页展示控件
+<br/>false:不允许在合同详情页展示控件
+<br/>默认false,在合同详情页不展示控件
+        :type ShowFlowDetailComponent: bool
+        :param _ShowTemplateComponent: 模版预览页面是否展示空间信息
+<br/>true:允许在模版预览页展示控件
+<br/>false:不允许在模版预览页展示控件
+<br/>默认false,在模版预览页不展示控件
+        :type ShowTemplateComponent: bool
+        """
+        self._ShowFlowDetailComponent = None
+        self._ShowTemplateComponent = None
+
+    @property
+    def ShowFlowDetailComponent(self):
+        return self._ShowFlowDetailComponent
+
+    @ShowFlowDetailComponent.setter
+    def ShowFlowDetailComponent(self, ShowFlowDetailComponent):
+        self._ShowFlowDetailComponent = ShowFlowDetailComponent
+
+    @property
+    def ShowTemplateComponent(self):
+        return self._ShowTemplateComponent
+
+    @ShowTemplateComponent.setter
+    def ShowTemplateComponent(self, ShowTemplateComponent):
+        self._ShowTemplateComponent = ShowTemplateComponent
+
+
+    def _deserialize(self, params):
+        self._ShowFlowDetailComponent = params.get("ShowFlowDetailComponent")
+        self._ShowTemplateComponent = params.get("ShowTemplateComponent")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
 class ExtentServiceAuthInfo(AbstractModel):
     """扩展服务开通和授权的详细信息
 
@@ -13993,7 +14092,7 @@ class FlowApproverInfo(AbstractModel):
 
     **各种场景传参说明**:
 
-    <table>     <thead>     <tr>         <th>场景编号</th>         <th>发起方类型</th>         <th>签署方类型</th>         <th>签署方传参说明</th>     </tr>     </thead>     <tbody>     <tr>         <td>场景一</td>         <td>第三方子企业A员工</td>         <td>第三方子企业A员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（必传）OpenId：企业员工标识</li>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>             </ul>         </td>     </tr>     <tr>         <td>场景二</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B(不指定经办人走领取方式)</td>         <td>             <ul>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）ApproverOption.FillType：需设置为1</li>             </ul>         </td>     </tr>     <tr>         <td>场景三</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B员工</td>         <td>  <ul>             <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>             <li>（必传）Name：签署方的名字</li>             <li>（必传）Mobile：签署方的手机号</li>             <li>（必传）OpenId：企业员工标识</li>             <li>（必传）OrganizationName：子企业名称</li>             <li>（必传）OrganizationOpenId：子企业的标识</li>             <li>（固定）ApproverType：需设置为ORGANIZATION</li>         </ul></td>     </tr>     <tr>         <td>场景四</td>         <td>第三方子企业A员工</td>         <td>个人/自然人</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（固定）ApproverType：需设置为PERSON</li>             </ul>         </td>     </tr>     <tr>         <td>场景五</td>         <td>第三方子企业A员工</td>         <td>SaaS平台企业员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）OrganizationName：SaaS企业的名字</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）NotChannelOrganization：需设置为True</li>             </ul>         </td>     </tr>     </tbody> </table>
+    <table>     <thead>     <tr>         <th>场景编号</th>         <th>发起方类型</th>         <th>签署方类型</th>         <th>签署方传参说明</th>     </tr>     </thead>     <tbody>     <tr>         <td>场景一</td>         <td>第三方子企业A员工</td>         <td>第三方子企业A员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（必传）OpenId：企业员工标识</li>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>             </ul>         </td>     </tr>     <tr>         <td>场景二</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B(不指定经办人走领取方式)</td>         <td>             <ul>                 <li>（必传）OrganizationName：子企业名称</li>                 <li>（必传）OrganizationOpenId：子企业的标识</li>                 <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）ApproverOption.FillType：需设置为1</li>             </ul>         </td>     </tr>     <tr>         <td>场景三</td>         <td>第三方子企业A员工</td>         <td>第三方子企业B员工</td>         <td>  <ul>             <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>             <li>（必传）Name：签署方的名字</li>             <li>（必传）Mobile：签署方的手机号</li>             <li>（必传）OpenId：企业员工标识</li>             <li>（必传）OrganizationName：子企业名称</li>             <li>（必传）OrganizationOpenId：子企业的标识</li>             <li>（固定）ApproverType：需设置为ORGANIZATION</li>         </ul></td>     </tr>     <tr>         <td>场景四</td>         <td>第三方子企业A员工</td>         <td>个人/自然人</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（固定）ApproverType：需设置为PERSON</li>             </ul>         </td>     </tr>     <tr>         <td>场景五</td>         <td>第三方子企业A员工</td>         <td>SaaS平台企业员工</td>         <td>             <ul>                 <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li>                 <li>（必传）OrganizationName：SaaS企业的名字</li>                 <li>（必传）Name：签署方的名字</li>                 <li>（必传）Mobile：签署方的手机号</li>                 <li>（不传）OrganizationOpenId：子企业的标识</li>    <li>（不传）OpenId：企业员工标识</li>               <li>（固定）ApproverType：需设置为ORGANIZATION</li>                 <li>（固定）NotChannelOrganization：需设置为True</li>             </ul>         </td>     </tr>     </tbody> </table>
 
 
     **注1**: `使用模板发起合同时，RecipientId（模板发起合同时）必传`

{tencentcloud-sdk-python-essbasic-3.0.1167 → tencentcloud-sdk-python-essbasic-3.0.1172}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1167
+Version: 3.0.1172
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

tencentcloud-sdk-python-essbasic-3.0.1172/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

@@ -0,0 +1 @@
+tencentcloud-sdk-python-common==3.0.1172

tencentcloud-sdk-python-essbasic-3.0.1167/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

@@ -1 +0,0 @@
-tencentcloud-sdk-python-common==3.0.1167