tencentcloud-sdk-python-essbasic 3.0.1085__tar.gz → 3.0.1088__tar.gz

{tencentcloud-sdk-python-essbasic-3.0.1085 → tencentcloud-sdk-python-essbasic-3.0.1088}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1085
+Version: 3.0.1088
 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.1085 → tencentcloud-sdk-python-essbasic-3.0.1088}/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.1085"],
+    install_requires=["tencentcloud-sdk-python-common==3.0.1088"],
     version=tencentcloud.__version__,
     description='Tencent Cloud Essbasic SDK for Python',
     long_description=open('README.rst').read(),

{tencentcloud-sdk-python-essbasic-3.0.1085 → tencentcloud-sdk-python-essbasic-3.0.1088}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1085'
+__version__ = '3.0.1088'

{tencentcloud-sdk-python-essbasic-3.0.1085 → tencentcloud-sdk-python-essbasic-3.0.1088}/tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -35,7 +35,7 @@ class EssbasicClient(AbstractClient):
         - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
         注:
-        - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+        - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
         - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
 
         :param request: Request instance for ChannelBatchCancelFlows.
@@ -67,7 +67,7 @@ class EssbasicClient(AbstractClient):
         - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
 
         注:
-        - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+        - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>
         - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
 
         :param request: Request instance for ChannelCancelFlow.
@@ -139,7 +139,7 @@ class EssbasicClient(AbstractClient):
 
 
     def ChannelCreateBatchCancelFlowUrl(self, request):
-        """通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同,   返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开,  跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
+        """通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同,   返回的链接需要有此权限的人<font color='red'>**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开,  跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
 
         适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
 
@@ -1692,11 +1692,11 @@ class EssbasicClient(AbstractClient):
         如若在模板中配置了动态表格, 上传的附件必须为A4大小
         合同发起人必须在电子签已经进行实名。
 
-        **整体的逻辑如下**
+        ### 一. 整体的逻辑如下
 
         ![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)
 
-        **可以作为发起方和签署方的角色列表**
+        ###  二. 可以作为发起方和签署方的角色列表
         <table>
         <thead>
         <tr>
@@ -1739,14 +1739,47 @@ class EssbasicClient(AbstractClient):
         </tbody>
         </table>
 
-        **注**:
-        `1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+        ### 三. 填充模版中定义的填写控件
+        模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
+        填充的传参示例如下
+        ```
+            request.FormFields = [{
+                    "ComponentName": "项目的名字",
+                    "ComponentValue": "休闲山庄"
+                }, {
+                    "ComponentName": "项目的地址",
+                    "ComponentValue": "凤凰山北侧",
+                }, {
+                    "ComponentName": "范围",
+                    "ComponentValue": "凤凰山至107国道",
+                }, {
+                    "ComponentName": "面积",
+                    "ComponentValue": "100亩",
+                }, {
+                    "ComponentName": "基本情况",
+                    "ComponentValue": "完好",
+                }, , {
+                    "ComponentName": "用途",
+                    "ComponentValue": "经营农家乐",
+                }
+            ]
+        ```
+        合成后合同样子示例
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
 
-        `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
 
-        `3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）`
 
-        `4. 静默（自动）签署不支持合同签署方存在填写功能`
+        ### 四. 注意
+        1. 发起合同时候,  作为<font color="red">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名
+
+        2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明
+
+        3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
+
+        4. <font color="red">静默（自动）签署不支持合同签署方存在填写</font>
+
+        5.  <font color="red">在下一步创建签署链接前，建议等待DocumentFill </font> <a href="https://qian.tencent.com/developers/partner/callback_types_file_resources">PDF合成完成的回调</a>或者睡眠几秒，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
 
         :param request: Request instance for CreateFlowsByTemplates.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowsByTemplatesRequest`
@@ -2409,9 +2442,9 @@ class EssbasicClient(AbstractClient):
     def SyncProxyOrganizationOperators(self, request):
         """此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。子客Web控制台的组织架构管理，是依赖于第三方应用平台的，无法针对员工做新增/更新/离职等操作。
 
-        - **新增员工的场景**:    提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
+        - **新增员工的场景**:    通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
 
-        - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了,   同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空,  再次加入公司会从零开始) ,  若员工信息有误可通过离职后在新增来解决,  离职员工状态为**离职**
+        - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了,   同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空,  再次加入公司会从零开始) ,  若员工信息有误可通过离职后在新增来解决,  离职员工状态为**离职**
 
         ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
 

{tencentcloud-sdk-python-essbasic-3.0.1085 → tencentcloud-sdk-python-essbasic-3.0.1088}/tencentcloud/essbasic/v20210526/models.py

@@ -8887,6 +8887,10 @@ class Component(AbstractModel):
 <ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>
 <b>参数样例</b>：` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
 
+<font color="red">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：
+<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>
+<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>
+<b>参数样例</b>：`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
 
 <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
 <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
@@ -9458,10 +9462,15 @@ class CreateChannelFlowEvidenceReportRequest(AbstractModel):
         :type FlowId: str
         :param _Operator: 暂未开放
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
+        :param _ReportType: 指定申请的报告类型，可选类型如下：
+<ul><li> **0** :合同签署报告（默认）</li>
+<li> **1** :公证处核验报告</li></ul>
+        :type ReportType: int
         """
         self._Agent = None
         self._FlowId = None
         self._Operator = None
+        self._ReportType = None
 
     @property
     def Agent(self):
@@ -9491,6 +9500,14 @@ class CreateChannelFlowEvidenceReportRequest(AbstractModel):
 
         self._Operator = Operator
 
+    @property
+    def ReportType(self):
+        return self._ReportType
+
+    @ReportType.setter
+    def ReportType(self, ReportType):
+        self._ReportType = ReportType
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -9500,6 +9517,7 @@ class CreateChannelFlowEvidenceReportRequest(AbstractModel):
         if params.get("Operator") is not None:
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
+        self._ReportType = params.get("ReportType")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -10899,6 +10917,8 @@ class CreateSignUrlsRequest(AbstractModel):
 <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
 <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型，此时返回长链</li></ul>
 
+**注：**动态签署人场景，如果签署链接类型设置为`APP`，则仅支持跳转到封面页。
+
 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
         :type Endpoint: str
         :param _GenerateType: 签署链接生成类型，可以选择的类型如下
@@ -11533,10 +11553,15 @@ class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
         :type ReportId: str
         :param _Operator: 暂未开放
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
+        :param _ReportType: 指定申请的报告类型，可选类型如下：
+<ul><li> **0** :合同签署报告（默认）</li>
+<li> **1** :公证处核验报告</li></ul>
+        :type ReportType: int
         """
         self._Agent = None
         self._ReportId = None
         self._Operator = None
+        self._ReportType = None
 
     @property
     def Agent(self):
@@ -11566,6 +11591,14 @@ class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
 
         self._Operator = Operator
 
+    @property
+    def ReportType(self):
+        return self._ReportType
+
+    @ReportType.setter
+    def ReportType(self, ReportType):
+        self._ReportType = ReportType
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -11575,6 +11608,7 @@ class DescribeChannelFlowEvidenceReportRequest(AbstractModel):
         if params.get("Operator") is not None:
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
+        self._ReportType = params.get("ReportType")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -15147,9 +15181,13 @@ class FormField(AbstractModel):
         :type ComponentValue: str
         :param _ComponentId: 表单域或控件的ID，跟ComponentName二选一，不能全为空；
 CreateFlowsByTemplates 接口不使用此字段。
+
+<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
 注意：此字段可能返回 null，表示取不到有效值。
         :type ComponentId: str
         :param _ComponentName: 控件的名字，跟ComponentId二选一，不能全为空
+
+<a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
 注意：此字段可能返回 null，表示取不到有效值。
         :type ComponentName: str
         :param _LockComponentValue: 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定

{tencentcloud-sdk-python-essbasic-3.0.1085 → tencentcloud-sdk-python-essbasic-3.0.1088}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1085
+Version: 3.0.1088
 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.1088/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

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

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

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