tencentcloud-sdk-python 3.0.1068__py2.py3-none-any.whl → 3.0.1075__py2.py3-none-any.whl

tencentcloud/ess/v20201111/models.py

@@ -2006,6 +2006,12 @@ class Component(AbstractModel):
 <font color="red">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：
 <ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>
 <b>参数样例</b>：` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
+
+
+<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
+<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
+场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。
+<b>参数样例</b>：` "{"IgnoreKeywordError":1}"`
         :type ComponentExtra: str
         :param _IsFormType: **在通过接口拉取控件信息场景下**，为出参参数，此控件是否通过表单域定位方式生成，默认false-不是，**发起合同时候不要填写此字段留空即可**
 注意：此字段可能返回 null，表示取不到有效值。
@@ -6978,12 +6984,17 @@ class CreatePrepareFlowRequest(AbstractModel):
         :param _ResourceId: 资源id，与ResourceType相对应，取值范围：
 <ul>
 <li>文件Id（通过UploadFiles获取文件资源Id）</li>
-<li>模板Id</li>
+<li>模板Id（通过控制台创建模板后获取模板Id）</li>
 </ul>
+注意：需要同时设置 ResourceType 参数指定资源类型
         :type ResourceId: str
         :param _FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
 
         :type FlowName: str
+        :param _ResourceType: 资源类型，取值有：
+<ul><li> **1**：模板</li>
+<li> **2**：文件（默认值）</li></ul>
+        :type ResourceType: int
         :param _Unordered: 合同流程的签署顺序类型：
 <ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
 <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
@@ -7006,10 +7017,6 @@ class CreatePrepareFlowRequest(AbstractModel):
 <ul><li> **OPEN**：开启（默认值）</li>
 <li> **CLOSE**：关闭</li></ul>
         :type IntelligentStatus: str
-        :param _ResourceType: 资源类型，取值有：
-<ul><li> **1**：模板</li>
-<li> **2**：文件（默认值）</li></ul>
-        :type ResourceType: int
         :param _Components: 该字段已废弃，请使用InitiatorComponents
         :type Components: :class:`tencentcloud.ess.v20201111.models.Component`
         :param _FlowOption: 发起合同个性化参数
@@ -7050,13 +7057,13 @@ class CreatePrepareFlowRequest(AbstractModel):
         self._Operator = None
         self._ResourceId = None
         self._FlowName = None
+        self._ResourceType = None
         self._Unordered = None
         self._Deadline = None
         self._UserFlowTypeId = None
         self._FlowType = None
         self._Approvers = None
         self._IntelligentStatus = None
-        self._ResourceType = None
         self._Components = None
         self._FlowOption = None
         self._NeedSignReview = None
@@ -7091,6 +7098,14 @@ class CreatePrepareFlowRequest(AbstractModel):
     def FlowName(self, FlowName):
         self._FlowName = FlowName
 
+    @property
+    def ResourceType(self):
+        return self._ResourceType
+
+    @ResourceType.setter
+    def ResourceType(self, ResourceType):
+        self._ResourceType = ResourceType
+
     @property
     def Unordered(self):
         return self._Unordered
@@ -7139,14 +7154,6 @@ class CreatePrepareFlowRequest(AbstractModel):
     def IntelligentStatus(self, IntelligentStatus):
         self._IntelligentStatus = IntelligentStatus
 
-    @property
-    def ResourceType(self):
-        return self._ResourceType
-
-    @ResourceType.setter
-    def ResourceType(self, ResourceType):
-        self._ResourceType = ResourceType
-
     @property
     def Components(self):
         return self._Components
@@ -7226,6 +7233,7 @@ class CreatePrepareFlowRequest(AbstractModel):
             self._Operator._deserialize(params.get("Operator"))
         self._ResourceId = params.get("ResourceId")
         self._FlowName = params.get("FlowName")
+        self._ResourceType = params.get("ResourceType")
         self._Unordered = params.get("Unordered")
         self._Deadline = params.get("Deadline")
         self._UserFlowTypeId = params.get("UserFlowTypeId")
@@ -7237,7 +7245,6 @@ class CreatePrepareFlowRequest(AbstractModel):
                 obj._deserialize(item)
                 self._Approvers.append(obj)
         self._IntelligentStatus = params.get("IntelligentStatus")
-        self._ResourceType = params.get("ResourceType")
         if params.get("Components") is not None:
             self._Components = Component()
             self._Components._deserialize(params.get("Components"))
@@ -11438,7 +11445,7 @@ class DescribeIntegrationRolesRequest(AbstractModel):
 分页参数, 需要limit, offset 配合使用
 例如:
 您希望得到第三页的数据, 且每页限制最多10条
-你可以使用 LIMIT 10 OFFSET 20
+您可以使用 LIMIT 10 OFFSET 20
 
         :type Offset: int
         """
@@ -11525,7 +11532,7 @@ class DescribeIntegrationRolesResponse(AbstractModel):
 分页参数, 需要limit, offset 配合使用
 例如:
 您希望得到第三页的数据, 且每页限制最多10条
-你可以使用 LIMIT 10 OFFSET 20
+您可以使用 LIMIT 10 OFFSET 20
         :type Offset: int
         :param _Limit: 指定分页每页返回的数据条数，单页最大支持 200。
         :type Limit: int

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -815,6 +815,41 @@ class EssbasicClient(AbstractClient):
         注意：
         1. 只支持PC浏览器操作使用
 
+        **嵌入式签署人-各种场景传参说明**:
+
+        <table>
+        <thead>
+        <tr>
+        <th>场景编号</th>
+        <th>可作为签署方的类型</th>
+        <th>签署方传参说明</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        <tr>
+        <td>场景一</td>
+        <td>第三方子企业A员工</td>
+        <td>OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
+        </tr>
+        <tr>
+        <td>场景二</td>
+        <td>第三方子企业B员工</td>
+        <td>OpenId、OrganizationOpenId、OrganizationName必传, ApproverType设置为ORGANIZATION</td>
+        </tr>
+        <tr>
+        <td>场景三</td>
+        <td>SaaS平台企业员工</td>
+        <td>Name、Mobile、OrganizationName必传，NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
+        </tr>
+        <tr>
+        <td>场景四</td>
+        <td>个人/自然人</td>
+        <td>Name、Mobile必传, ApproverType设置为PERSON</td>
+        </tr>
+        </tbody>
+        </table>
+
         嵌入的页面样式如下：
         ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
 
@@ -1489,16 +1524,26 @@ class EssbasicClient(AbstractClient):
 
 
     def CreateChannelOrganizationInfoChangeUrl(self, request):
-        """此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接（需要在移动端打开，会跳转到微信小程序），支持创建企业超管变更链接或企业基础信息变更链接，通过入参 ChangeType 指定。
+        """此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接。
+
+        <h3 id="1">支持变更链接类型，通过入参 Endpoint 指定，默认为WEIXINAPP。</h3>
+
+        <h4 id="WEIXINAPP">WEIXINAPP</h4>
+        <p>创建变更短链。需要在移动端打开，会跳转到微信腾讯电子签小程序进行更换。</p>
+
+        <h4 id="APP">APP</h4>
+        <p>创建变更小程序链接，可从第三方App跳转到微信腾讯电子签小程序进行更换。</p>
+
 
+        <h3 id="2">支持创建企业超管变更链接或企业基础信息变更链接，通过入参 ChangeType 指定。</h3>
 
-        <h3 id="1-企业超管变更">1. 企业超管变更</h3>
+        <h4 id="1-企业超管变更">1. 企业超管变更</h4>
 
         <p>换成企业的其他员工来当超管</p>
 
-        <h3 id="2-企业基础信息变更">2. 企业基础信息变更</h3>
+        <h4 id="2-企业基础信息变更">2. 企业基础信息变更</h4>
 
-        <h4 id="可以变动">可以变动</h4>
+        <h5 id="可以变动">可以变动</h5>
 
         <ul>
         <li>企业名称<br>
@@ -1508,7 +1553,7 @@ class EssbasicClient(AbstractClient):
         <li>企业地址和所在地</li>
         </ul>
 
-        <h4 id="不可变动">不可变动</h4>
+        <h5 id="不可变动">不可变动</h5>
 
         <ul>
         <li>统一社会信用代码<br>
@@ -1559,6 +1604,7 @@ class EssbasicClient(AbstractClient):
         <th>子客企业状态</th>
         <th>子客企业员工状态</th>
         <th>点击链接进入的流程</th>
+        <th>视频样例</th>
         </tr>
         </thead>
         <tbody>
@@ -1566,16 +1612,19 @@ class EssbasicClient(AbstractClient):
         <td>企业未激活</td>
         <td>员工未认证</td>
         <td>进入企业激活流程，首次完成企业激活流程的员工会成为超管</td>
+        <td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
         </tr>
         <tr>
         <td>企业已激活</td>
         <td>员工未认证</td>
         <td>进入员认证并加入企业流程</td>
+        <td>-</td>
         </tr>
         <tr>
         <td>企业已激活</td>
         <td>员工已认证</td>
         <td>进入子客企业Web控制台</td>
+        <td>-</td>
         </tr>
         </tbody>
         </table>