tencentcloud-sdk-python-ess 3.1.166__tar.gz → 3.1.172__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/PKG-INFO +2 -2
  2. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/setup.py +1 -1
  3. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/ess_client.py +71 -106
  5. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/ess_client_async.py +71 -106
  6. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/models.py +78 -152
  7. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +2 -2
  8. tencentcloud_sdk_python_ess-3.1.172/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
  9. tencentcloud_sdk_python_ess-3.1.166/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
  10. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/README.rst +0 -0
  11. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/setup.cfg +0 -0
  12. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/__init__.py +0 -0
  13. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/__init__.py +0 -0
  14. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
  15. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
  16. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
  17. {tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud_sdk_python_ess.egg-info/top_level.txt +0 -0
{tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.166
3
+ Version: 3.1.172
4
4
  Summary: Tencent Cloud Ess SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.166
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.172
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
{tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/setup.py RENAMED
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-ess',
11
- install_requires=["tencentcloud-sdk-python-common>=3.1.166,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.1.172,<4.0.0"],
12
12
 
13
13
  version=tencentcloud.__version__,
14
14
  description='Tencent Cloud Ess SDK for Python',
{tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/__init__.py RENAMED
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.1.166'
17
+ __version__ = '3.1.172'
{tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/ess_client.py RENAMED
@@ -755,49 +755,43 @@ class EssClient(AbstractClient):
755
755
 
756
756
 
757
757
  def CreateDocument(self, request):
758
- r"""创建签署流程电子文档<br />
758
+ r"""本接口用于基于**模板**创建合同的电子文档，并填充模板中由发起方补充的信息（归属发起方填写控件）。
759
759
 
760
- ### 调用流程
761
- 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
760
+ ### 1.1 调用流程
762
761
 
763
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
762
+ 本接口需指定一个模板 ID，并填充该模板中需补充的信息。它需要与<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口配合使用，完整调用顺序如下：
763
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
764
764
 
765
+ ### 1.2 发起方填写控件
765
766
 
766
- ### 填充模板中定义的填写控件
767
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
768
-
769
- **<font color="red">填充填写控件需要进行Pdf合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
767
+ 模板中配置的<font color="red">发起人填充控件</font>，可通过本接口的 **FormFields 数组**字段填充。
770
768
 
771
769
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
772
770
 
773
- 填充的传参示例如下
774
-
775
- ```
776
- request.FormFields = [{
777
- "ComponentName": "项目的名字",
778
- "ComponentValue": "休闲山庄"
779
- }, {
780
- "ComponentName": "项目的地址",
781
- "ComponentValue": "凤凰山北侧",
782
- }, {
783
- "ComponentName": "范围",
784
- "ComponentValue": "凤凰山至107国道",
785
- }, {
786
- "ComponentName": "面积",
787
- "ComponentValue": "100亩",
788
- }, {
789
- "ComponentName": "基本情况",
790
- "ComponentValue": "完好",
791
- }, , {
792
- "ComponentName": "用途",
793
- "ComponentValue": "经营农家乐",
794
- }
795
- ]
771
+ 填充的传参示例如下（以 ComponentName 匹配模板中的控件名）：
772
+
773
+ ```json
774
+ [
775
+ { "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" },
776
+ { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧" },
777
+ { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道" },
778
+ { "ComponentName": "面积", "ComponentValue": "100亩" },
779
+ { "ComponentName": "基本情况", "ComponentValue": "完好" },
780
+ { "ComponentName": "用途", "ComponentValue": "经营农家乐" }
781
+ ]
796
782
  ```
797
- 合成后合同样子示例
783
+
784
+ 合成后的合同样例：
798
785
 
799
786
  ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
800
787
 
788
+ ### 1.3 注意事项
789
+
790
+ - 本接口<font color="red">只能填充分配给发起方的填写控件</font>，不能填充分配给签署方的签署控件。
791
+ - <font color="red">若使用预览方式（`NeedPreview=true`），预览确认无误后，需用同样的参数再次调用本接口</font>（`NeedPreview=false`），并使用新调用返回的 `FlowId` 去调用 <a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">StartFlow</a>发起签署。预览模式返回的 `FlowId` 为临时 ID，不能用于发起。
792
+ - 只要存在发起方的填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。<font color="red">一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署</font>，以确保文档已合成完毕。
793
+ - 调用本接口（CreateDocument）成功后，请**在 5 分钟内调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 启动合同**，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
794
+
801
795
  :param request: Request instance for CreateDocument.
802
796
  :type request: :class:`tencentcloud.ess.v20201111.models.CreateDocumentRequest`
803
797
  :rtype: :class:`tencentcloud.ess.v20201111.models.CreateDocumentResponse`
@@ -1060,40 +1054,26 @@ class EssClient(AbstractClient):
1060
1054
 
1061
1055
  def CreateFlow(self, request):
1062
1056
  r"""通过模板创建签署流程<br/>
1063
- 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
1064
- <table>
1065
- <thead>
1066
- <tr>
1067
- <th>签署人类别</th>
1068
- <th>需要提前准备的信息</th>
1069
- </tr>
1070
- </thead>
1071
- <tbody>
1072
- <tr>
1073
- <td>自己企业的员工签署（未认证加入或已认证加入）</td>
1074
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
1075
- </tr>
1076
- <tr>
1077
- <td>自己企业的员工签署（已认证加入）</td>
1078
- <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
1079
- </tr>
1080
- <tr>
1081
- <td>其他企业的员工签署</td>
1082
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
1083
- </tr>
1084
- <tr>
1085
- <td>个人（自然人）签署</td>
1086
- <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
1087
- </tr>
1088
- </tbody>
1089
- </table>
1090
-
1091
-
1092
- 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
1093
-
1094
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
1095
-
1096
- 注：**静默（自动）签署不支持合同签署方存在填写**功能
1057
+ 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次使用这个配置好的模板，补充合同内容信息及签署信息生成电子合同。
1058
+ ## 1.1 传参方式指引
1059
+
1060
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
1061
+ |------|------|------|------|
1062
+ | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
1063
+ | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
1064
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
1065
+ | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
1066
+
1067
+ ## 1.2 接口调用流程
1068
+ 此接口需<font color="red">配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用</font> 。整体的逻辑如下图
1069
+
1070
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
1071
+
1072
+ ## 1.3 注意事项
1073
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
1074
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
1075
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
1076
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
1097
1077
  <br>
1098
1078
 
1099
1079
  <font color="red">相关视频指引</font> <br>
@@ -1224,43 +1204,26 @@ class EssClient(AbstractClient):
1224
1204
  r"""此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
1225
1205
  适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
1226
1206
 
1227
- <table>
1228
- <thead>
1229
- <tr>
1230
- <th>签署人类别</th>
1231
- <th>需要提前准备的信息</th>
1232
- </tr>
1233
- </thead>
1234
- <tbody>
1235
- <tr>
1236
- <td>自己企业的员工签署（未认证加入或已认证加入）</td>
1237
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
1238
- </tr>
1239
- <tr>
1240
- <td>自己企业的员工签署（已认证加入）</td>
1241
- <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
1242
- </tr>
1243
- <tr>
1244
- <td>其他企业的员工签署</td>
1245
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
1246
- </tr>
1247
- <tr>
1248
- <td>个人（自然人）签署</td>
1249
- <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
1250
- </tr>
1251
- </tbody>
1252
- </table>
1207
+ ## 传参方式指引
1253
1208
 
1209
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
1210
+ |------|------|------|------|
1211
+ | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
1212
+ | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
1213
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
1214
+ | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
1254
1215
 
1255
1216
 
1256
- 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
1217
+ 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask)接口转换成pdf资源）<br/>
1257
1218
 
1258
-
1259
- ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
1219
+ ## 整体流程图
1220
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
1260
1221
 
1261
1222
  注：
1262
- - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
1263
- - **静默（自动）签署不支持合同签署方存在填写**功能
1223
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
1224
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
1225
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
1226
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
1264
1227
 
1265
1228
 
1266
1229
  <font color="red">相关视频指引</font> <br>
@@ -2440,7 +2403,7 @@ class EssClient(AbstractClient):
2440
2403
  ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
2441
2404
  # 4. 计算完整性签名：HMAC(Key, IV || Ciphertext)
2442
2405
  signature = HMAC(HMACKey, concat(iv, ciphertext))
2443
- # 5. 组装外层请求参数（三段均为标准 Base64）
2406
+ # 5. 组装外层请求参数
2444
2407
  encReq = {
2445
2408
  RequestAction: bizAction,
2446
2409
  IV: Base64(iv),
@@ -2478,6 +2441,7 @@ class EssClient(AbstractClient):
2478
2441
  ```
2479
2442
 
2480
2443
  **AES-CBC 示例**
2444
+
2481
2445
  以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
2482
2446
 
2483
2447
  加密密钥：AES-CBC-Key-1234
@@ -2496,6 +2460,7 @@ class EssClient(AbstractClient):
2496
2460
  ```
2497
2461
 
2498
2462
  **SM4-CBC 示例**
2463
+
2499
2464
  以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
2500
2465
 
2501
2466
  加密密钥：SM4-CBC-Key-1234
@@ -4745,16 +4710,16 @@ class EssClient(AbstractClient):
4745
4710
 
4746
4711
  def StartFlow(self, request):
4747
4712
  r"""此接口用于启动流程。它是模板发起合同的最后一步。
4748
- 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
4749
-
4750
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
4751
4713
 
4752
- 注：
4753
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
4714
+ ## 1.1 接口调用流程
4715
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
4754
4716
 
4755
- 2.<font color="red">静默（自动）签署不支持非本企业合同签署方存在填写</font>功能
4717
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
4756
4718
 
4757
- 3.<font color="red">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
4719
+ ### 1.2 注意事项
4720
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
4721
+ - 只要存在填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。**一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署**，以确保文档已合成完毕。，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
4722
+ - 调用 [CreateDocument](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument) 成功后，请<font color="red">在 5 分钟内调用本接口（StartFlow）启动合同</font> ，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
4758
4723
 
4759
4724
  :param request: Request instance for StartFlow.
4760
4725
  :type request: :class:`tencentcloud.ess.v20201111.models.StartFlowRequest`
@@ -4860,7 +4825,7 @@ class EssClient(AbstractClient):
4860
4825
 
4861
4826
  适用场景：用于合同，印章的文件上传。文件上传以后，
4862
4827
  如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
4863
- 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
4828
+ 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务</a>接口转换成PDF文件
4864
4829
 
4865
4830
  注:
4866
4831
  1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
{tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/ess_client_async.py RENAMED
@@ -644,48 +644,42 @@ class EssClient(AbstractClient):
644
644
  opts: Dict = None,
645
645
  ) -> models.CreateDocumentResponse:
646
646
  """
647
- 创建签署流程电子文档<br />
647
+ 本接口用于基于**模板**创建合同的电子文档，并填充模板中由发起方补充的信息（归属发起方填写控件）。
648
648
 
649
- ### 调用流程
650
- 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
649
+ ### 1.1 调用流程
651
650
 
652
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
651
+ 本接口需指定一个模板 ID，并填充该模板中需补充的信息。它需要与<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口配合使用，完整调用顺序如下：
652
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
653
653
 
654
+ ### 1.2 发起方填写控件
654
655
 
655
- ### 填充模板中定义的填写控件
656
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
657
-
658
- **<font color="red">填充填写控件需要进行Pdf合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
656
+ 模板中配置的<font color="red">发起人填充控件</font>，可通过本接口的 **FormFields 数组**字段填充。
659
657
 
660
658
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
661
659
 
662
- 填充的传参示例如下
663
-
664
- ```
665
- request.FormFields = [{
666
- "ComponentName": "项目的名字",
667
- "ComponentValue": "休闲山庄"
668
- }, {
669
- "ComponentName": "项目的地址",
670
- "ComponentValue": "凤凰山北侧",
671
- }, {
672
- "ComponentName": "范围",
673
- "ComponentValue": "凤凰山至107国道",
674
- }, {
675
- "ComponentName": "面积",
676
- "ComponentValue": "100亩",
677
- }, {
678
- "ComponentName": "基本情况",
679
- "ComponentValue": "完好",
680
- }, , {
681
- "ComponentName": "用途",
682
- "ComponentValue": "经营农家乐",
683
- }
684
- ]
660
+ 填充的传参示例如下（以 ComponentName 匹配模板中的控件名）：
661
+
662
+ ```json
663
+ [
664
+ { "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" },
665
+ { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧" },
666
+ { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道" },
667
+ { "ComponentName": "面积", "ComponentValue": "100亩" },
668
+ { "ComponentName": "基本情况", "ComponentValue": "完好" },
669
+ { "ComponentName": "用途", "ComponentValue": "经营农家乐" }
670
+ ]
685
671
  ```
686
- 合成后合同样子示例
672
+
673
+ 合成后的合同样例：
687
674
 
688
675
  ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
676
+
677
+ ### 1.3 注意事项
678
+
679
+ - 本接口<font color="red">只能填充分配给发起方的填写控件</font>，不能填充分配给签署方的签署控件。
680
+ - <font color="red">若使用预览方式（`NeedPreview=true`），预览确认无误后，需用同样的参数再次调用本接口</font>（`NeedPreview=false`），并使用新调用返回的 `FlowId` 去调用 <a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">StartFlow</a>发起签署。预览模式返回的 `FlowId` 为临时 ID，不能用于发起。
681
+ - 只要存在发起方的填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。<font color="red">一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署</font>，以确保文档已合成完毕。
682
+ - 调用本接口（CreateDocument）成功后，请**在 5 分钟内调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 启动合同**，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
689
683
  """
690
684
 
691
685
  kwargs = {}
@@ -904,40 +898,26 @@ class EssClient(AbstractClient):
904
898
  ) -> models.CreateFlowResponse:
905
899
  """
906
900
  通过模板创建签署流程<br/>
907
- 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
908
- <table>
909
- <thead>
910
- <tr>
911
- <th>签署人类别</th>
912
- <th>需要提前准备的信息</th>
913
- </tr>
914
- </thead>
915
- <tbody>
916
- <tr>
917
- <td>自己企业的员工签署（未认证加入或已认证加入）</td>
918
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
919
- </tr>
920
- <tr>
921
- <td>自己企业的员工签署（已认证加入）</td>
922
- <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
923
- </tr>
924
- <tr>
925
- <td>其他企业的员工签署</td>
926
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
927
- </tr>
928
- <tr>
929
- <td>个人（自然人）签署</td>
930
- <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
931
- </tr>
932
- </tbody>
933
- </table>
934
-
935
-
936
- 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
937
-
938
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
939
-
940
- 注：**静默（自动）签署不支持合同签署方存在填写**功能
901
+ 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次使用这个配置好的模板，补充合同内容信息及签署信息生成电子合同。
902
+ ## 1.1 传参方式指引
903
+
904
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
905
+ |------|------|------|------|
906
+ | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
907
+ | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
908
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
909
+ | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
910
+
911
+ ## 1.2 接口调用流程
912
+ 此接口需<font color="red">配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用</font> 。整体的逻辑如下图
913
+
914
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
915
+
916
+ ## 1.3 注意事项
917
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
918
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
919
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
920
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
941
921
  <br>
942
922
 
943
923
  <font color="red">相关视频指引</font> <br>
@@ -1053,43 +1033,26 @@ class EssClient(AbstractClient):
1053
1033
  此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
1054
1034
  适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
1055
1035
 
1056
- <table>
1057
- <thead>
1058
- <tr>
1059
- <th>签署人类别</th>
1060
- <th>需要提前准备的信息</th>
1061
- </tr>
1062
- </thead>
1063
- <tbody>
1064
- <tr>
1065
- <td>自己企业的员工签署（未认证加入或已认证加入）</td>
1066
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
1067
- </tr>
1068
- <tr>
1069
- <td>自己企业的员工签署（已认证加入）</td>
1070
- <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
1071
- </tr>
1072
- <tr>
1073
- <td>其他企业的员工签署</td>
1074
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
1075
- </tr>
1076
- <tr>
1077
- <td>个人（自然人）签署</td>
1078
- <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
1079
- </tr>
1080
- </tbody>
1081
- </table>
1036
+ ## 传参方式指引
1082
1037
 
1038
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
1039
+ |------|------|------|------|
1040
+ | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
1041
+ | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
1042
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
1043
+ | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
1083
1044
 
1084
1045
 
1085
- 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
1046
+ 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask)接口转换成pdf资源）<br/>
1086
1047
 
1087
-
1088
- ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
1048
+ ## 整体流程图
1049
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
1089
1050
 
1090
1051
  注：
1091
- - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
1092
- - **静默（自动）签署不支持合同签署方存在填写**功能
1052
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
1053
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
1054
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
1055
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
1093
1056
 
1094
1057
 
1095
1058
  <font color="red">相关视频指引</font> <br>
@@ -2104,7 +2067,7 @@ class EssClient(AbstractClient):
2104
2067
  ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
2105
2068
  # 4. 计算完整性签名：HMAC(Key, IV || Ciphertext)
2106
2069
  signature = HMAC(HMACKey, concat(iv, ciphertext))
2107
- # 5. 组装外层请求参数（三段均为标准 Base64）
2070
+ # 5. 组装外层请求参数
2108
2071
  encReq = {
2109
2072
  RequestAction: bizAction,
2110
2073
  IV: Base64(iv),
@@ -2142,6 +2105,7 @@ class EssClient(AbstractClient):
2142
2105
  ```
2143
2106
 
2144
2107
  **AES-CBC 示例**
2108
+
2145
2109
  以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
2146
2110
 
2147
2111
  加密密钥：AES-CBC-Key-1234
@@ -2160,6 +2124,7 @@ class EssClient(AbstractClient):
2160
2124
  ```
2161
2125
 
2162
2126
  **SM4-CBC 示例**
2127
+
2163
2128
  以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
2164
2129
 
2165
2130
  加密密钥：SM4-CBC-Key-1234
@@ -3999,16 +3964,16 @@ class EssClient(AbstractClient):
3999
3964
  ) -> models.StartFlowResponse:
4000
3965
  """
4001
3966
  此接口用于启动流程。它是模板发起合同的最后一步。
4002
- 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
4003
-
4004
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
4005
3967
 
4006
- 注：
4007
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
3968
+ ## 1.1 接口调用流程
3969
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
4008
3970
 
4009
- 2.<font color="red">静默（自动）签署不支持非本企业合同签署方存在填写</font>功能
3971
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
4010
3972
 
4011
- 3.<font color="red">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
3973
+ ### 1.2 注意事项
3974
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
3975
+ - 只要存在填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。**一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署**，以确保文档已合成完毕。，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
3976
+ - 调用 [CreateDocument](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument) 成功后，请<font color="red">在 5 分钟内调用本接口（StartFlow）启动合同</font> ，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
4012
3977
  """
4013
3978
 
4014
3979
  kwargs = {}
@@ -4099,7 +4064,7 @@ class EssClient(AbstractClient):
4099
4064
 
4100
4065
  适用场景：用于合同，印章的文件上传。文件上传以后，
4101
4066
  如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
4102
- 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
4067
+ 如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务</a>接口转换成PDF文件
4103
4068
 
4104
4069
  注:
4105
4070
  1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
{tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud/ess/v20201111/models.py RENAMED
@@ -231,13 +231,13 @@ class Agent(AbstractModel):
231
231
 
232
232
  def __init__(self):
233
233
  r"""
234
- :param _AppId: 代理机构的应用编号,32位字符串，一般不用传
234
+ :param _AppId: <p>CA-API应用编号，用于同平台企业下标识不同的CA-API应用</p>
235
235
  :type AppId: str
236
- :param _ProxyAppId: 被代理机构的应用号，一般不用传
236
+ :param _ProxyAppId: <p>被代理机构的应用号，一般不用传</p>
237
237
  :type ProxyAppId: str
238
- :param _ProxyOrganizationId: 被代理机构在电子签平台的机构编号，集团代理下场景必传
238
+ :param _ProxyOrganizationId: <p>被代理机构在电子签平台的机构编号，集团代理下场景必传</p>
239
239
  :type ProxyOrganizationId: str
240
- :param _ProxyOperator: 被代理机构的经办人，一般不用传
240
+ :param _ProxyOperator: <p>被代理机构的经办人，一般不用传</p>
241
241
  :type ProxyOperator: str
242
242
  """
243
243
  self._AppId = None
@@ -249,7 +249,7 @@ class Agent(AbstractModel):
249
249
  def AppId(self):
250
250
  warnings.warn("parameter `AppId` is deprecated", DeprecationWarning)
251
251
 
252
- r"""代理机构的应用编号,32位字符串，一般不用传
252
+ r"""<p>CA-API应用编号，用于同平台企业下标识不同的CA-API应用</p>
253
253
  :rtype: str
254
254
  """
255
255
  return self._AppId
@@ -264,7 +264,7 @@ class Agent(AbstractModel):
264
264
  def ProxyAppId(self):
265
265
  warnings.warn("parameter `ProxyAppId` is deprecated", DeprecationWarning)
266
266
 
267
- r"""被代理机构的应用号，一般不用传
267
+ r"""<p>被代理机构的应用号，一般不用传</p>
268
268
  :rtype: str
269
269
  """
270
270
  return self._ProxyAppId
@@ -277,7 +277,7 @@ class Agent(AbstractModel):
277
277
 
278
278
  @property
279
279
  def ProxyOrganizationId(self):
280
- r"""被代理机构在电子签平台的机构编号，集团代理下场景必传
280
+ r"""<p>被代理机构在电子签平台的机构编号，集团代理下场景必传</p>
281
281
  :rtype: str
282
282
  """
283
283
  return self._ProxyOrganizationId
@@ -290,7 +290,7 @@ class Agent(AbstractModel):
290
290
  def ProxyOperator(self):
291
291
  warnings.warn("parameter `ProxyOperator` is deprecated", DeprecationWarning)
292
292
 
293
- r"""被代理机构的经办人，一般不用传
293
+ r"""<p>被代理机构的经办人，一般不用传</p>
294
294
  :rtype: str
295
295
  """
296
296
  return self._ProxyOperator
@@ -918,6 +918,8 @@ class ApproverOption(AbstractModel):
918
918
  :type ApproverMobileMode: str
919
919
  :param _ForbidModifySealInfos: <p>在嵌入式文件发起下,若合同是通过文件,当签署人控件指定了印章类型（或印章Id）,在嵌入页面上是否能修改</p>
920
920
  :type ForbidModifySealInfos: bool
921
+ :param _AddSignComponentUseSealSize: <p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件（SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL）时，「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值：</p><ul><li>0： 默认关闭，可开启。与现网一致</li><li>1： 关闭且置灰——按控件默认的4.2cm尺寸盖章，签署方无法开启开关 </li><li>2： 默认开启且可修改——默认按印章实际尺寸盖章，签署方可手动关闭</li><li>3： 开启且置灰——强制按印章实际尺寸盖章，签署方不可修改。</li></ul><p>默认值：0</p>
922
+ :type AddSignComponentUseSealSize: int
921
923
  """
922
924
  self._NoRefuse = None
923
925
  self._NoTransfer = None
@@ -927,6 +929,7 @@ class ApproverOption(AbstractModel):
927
929
  self._ForbidAddSignDate = None
928
930
  self._ApproverMobileMode = None
929
931
  self._ForbidModifySealInfos = None
932
+ self._AddSignComponentUseSealSize = None
930
933
 
931
934
  @property
932
935
  def NoRefuse(self):
@@ -1016,6 +1019,17 @@ class ApproverOption(AbstractModel):
1016
1019
  def ForbidModifySealInfos(self, ForbidModifySealInfos):
1017
1020
  self._ForbidModifySealInfos = ForbidModifySealInfos
1018
1021
 
1022
+ @property
1023
+ def AddSignComponentUseSealSize(self):
1024
+ r"""<p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件（SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL）时，「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值：</p><ul><li>0： 默认关闭，可开启。与现网一致</li><li>1： 关闭且置灰——按控件默认的4.2cm尺寸盖章，签署方无法开启开关 </li><li>2： 默认开启且可修改——默认按印章实际尺寸盖章，签署方可手动关闭</li><li>3： 开启且置灰——强制按印章实际尺寸盖章，签署方不可修改。</li></ul><p>默认值：0</p>
1025
+ :rtype: int
1026
+ """
1027
+ return self._AddSignComponentUseSealSize
1028
+
1029
+ @AddSignComponentUseSealSize.setter
1030
+ def AddSignComponentUseSealSize(self, AddSignComponentUseSealSize):
1031
+ self._AddSignComponentUseSealSize = AddSignComponentUseSealSize
1032
+
1019
1033
 
1020
1034
  def _deserialize(self, params):
1021
1035
  self._NoRefuse = params.get("NoRefuse")
@@ -1026,6 +1040,7 @@ class ApproverOption(AbstractModel):
1026
1040
  self._ForbidAddSignDate = params.get("ForbidAddSignDate")
1027
1041
  self._ApproverMobileMode = params.get("ApproverMobileMode")
1028
1042
  self._ForbidModifySealInfos = params.get("ForbidModifySealInfos")
1043
+ self._AddSignComponentUseSealSize = params.get("AddSignComponentUseSealSize")
1029
1044
  memeber_set = set(params.keys())
1030
1045
  for name, value in vars(self).items():
1031
1046
  property_name = name[1:]
@@ -1838,50 +1853,21 @@ class AutoSignConfig(AbstractModel):
1838
1853
 
1839
1854
  def __init__(self):
1840
1855
  r"""
1841
- :param _UserInfo: 自动签开通个人用户信息, 包括名字,身份证等
1856
+ :param _UserInfo: <p>自动签开通个人用户信息, 包括名字,身份证等</p>
1842
1857
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
1843
- :param _CertInfoCallback: 是否回调证书信息:
1844
- <ul><li>**false**: 不需要(默认)</li>
1845
- <li>**true**:需要</li></ul>
1846
-
1847
- 注：`该字段已经失效，请勿设置此参数。`
1858
+ :param _CertInfoCallback: <p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注：<code>该字段已经失效，请勿设置此参数。</code></p>
1848
1859
  :type CertInfoCallback: bool
1849
- :param _UserDefineSeal: 是否支持用户自定义签名印章:
1850
- <ul><li>**false**: 不能自己定义(默认)</li>
1851
- <li>**true**: 可以自己定义</li></ul>
1860
+ :param _UserDefineSeal: <p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
1852
1861
  :type UserDefineSeal: bool
1853
- :param _SealImgCallback: 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
1854
- <ul><li>**false**: 不需要(默认)</li>
1855
- <li>**true**: 需要</li></ul>
1862
+ :param _SealImgCallback: <p>回调中是否需要自动签将要使用的印章(签名) 图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
1856
1863
  :type SealImgCallback: bool
1857
- :param _CallbackUrl: 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
1858
- 腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
1859
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
1864
+ :param _CallbackUrl: <p>执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。<br>腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
1860
1865
  :type CallbackUrl: str
1861
- :param _VerifyChannels: 开通时候的身份验证方式, 取值为：
1862
- <ul><li>**WEIXINAPP** : 微信人脸识别</li>
1863
- <li>**INSIGHT** : 慧眼人脸识别</li>
1864
- <li>**TELECOM** : 运营商三要素验证</li></ul>
1865
- 注：
1866
- <ul><li>如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li>
1867
- <li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
1866
+ :param _VerifyChannels: <p>开通时候的身份验证方式, 取值为：</p><ul><li>**WEIXINAPP** : 微信人脸识别</li><li>**INSIGHT** : 慧眼人脸识别</li><li>**TELECOM** : 运营商三要素验证</li></ul>注：<ul><li>如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li><li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
1868
1867
  :type VerifyChannels: list of str
1869
- :param _LicenseType: 设置用户自动签合同的扣费方式。
1870
-
1871
- <ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul>
1872
-
1873
- 注：`该字段已经失效，请勿设置此参数。`
1868
+ :param _LicenseType: <p>设置用户自动签合同的扣费方式。</p><ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul><p>注：<code>该字段已经失效，请勿设置此参数。</code></p>
1874
1869
  :type LicenseType: int
1875
- :param _JumpUrl: 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
1876
-
1877
- 注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
1878
-
1879
- 跳转场景：
1880
- <ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>
1881
- <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
1882
-
1883
- 成功结果返回：
1884
- 若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
1870
+ :param _JumpUrl: <p>开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。</p><p>注：<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景：</p><ul><li>**贵方H5 -&gt; 腾讯电子签H5 -&gt; 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -&gt; 腾讯电子签H5 -&gt; 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。<code>APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。</code>APP拦截地址跳转可参考：<a href="https://qian.tencent.com/developers/company/openqianh5/#3-%E8%BF%94%E5%9B%9E%E5%BA%94%E7%94%A8jumpurl%E6%A0%BC%E5%BC%8F">返回应用JumpUrl格式</a></li></ul><p>成功结果返回：<br>若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：<code>appendResult=qian</code>。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&amp;result=success&amp;from=tencent_ess</p>
1885
1871
  :type JumpUrl: str
1886
1872
  """
1887
1873
  self._UserInfo = None
@@ -1895,7 +1881,7 @@ class AutoSignConfig(AbstractModel):
1895
1881
 
1896
1882
  @property
1897
1883
  def UserInfo(self):
1898
- r"""自动签开通个人用户信息, 包括名字,身份证等
1884
+ r"""<p>自动签开通个人用户信息, 包括名字,身份证等</p>
1899
1885
  :rtype: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
1900
1886
  """
1901
1887
  return self._UserInfo
@@ -1906,11 +1892,7 @@ class AutoSignConfig(AbstractModel):
1906
1892
 
1907
1893
  @property
1908
1894
  def CertInfoCallback(self):
1909
- r"""是否回调证书信息:
1910
- <ul><li>**false**: 不需要(默认)</li>
1911
- <li>**true**:需要</li></ul>
1912
-
1913
- 注：`该字段已经失效，请勿设置此参数。`
1895
+ r"""<p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注：<code>该字段已经失效，请勿设置此参数。</code></p>
1914
1896
  :rtype: bool
1915
1897
  """
1916
1898
  return self._CertInfoCallback
@@ -1921,9 +1903,7 @@ class AutoSignConfig(AbstractModel):
1921
1903
 
1922
1904
  @property
1923
1905
  def UserDefineSeal(self):
1924
- r"""是否支持用户自定义签名印章:
1925
- <ul><li>**false**: 不能自己定义(默认)</li>
1926
- <li>**true**: 可以自己定义</li></ul>
1906
+ r"""<p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
1927
1907
  :rtype: bool
1928
1908
  """
1929
1909
  return self._UserDefineSeal
@@ -1934,9 +1914,7 @@ class AutoSignConfig(AbstractModel):
1934
1914
 
1935
1915
  @property
1936
1916
  def SealImgCallback(self):
1937
- r"""回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
1938
- <ul><li>**false**: 不需要(默认)</li>
1939
- <li>**true**: 需要</li></ul>
1917
+ r"""<p>回调中是否需要自动签将要使用的印章(签名) 图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
1940
1918
  :rtype: bool
1941
1919
  """
1942
1920
  return self._SealImgCallback
@@ -1949,9 +1927,7 @@ class AutoSignConfig(AbstractModel):
1949
1927
  def CallbackUrl(self):
1950
1928
  warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
1951
1929
 
1952
- r"""执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
1953
- 腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
1954
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
1930
+ r"""<p>执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。<br>腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
1955
1931
  :rtype: str
1956
1932
  """
1957
1933
  return self._CallbackUrl
@@ -1964,13 +1940,7 @@ class AutoSignConfig(AbstractModel):
1964
1940
 
1965
1941
  @property
1966
1942
  def VerifyChannels(self):
1967
- r"""开通时候的身份验证方式, 取值为：
1968
- <ul><li>**WEIXINAPP** : 微信人脸识别</li>
1969
- <li>**INSIGHT** : 慧眼人脸识别</li>
1970
- <li>**TELECOM** : 运营商三要素验证</li></ul>
1971
- 注：
1972
- <ul><li>如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li>
1973
- <li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
1943
+ r"""<p>开通时候的身份验证方式, 取值为：</p><ul><li>**WEIXINAPP** : 微信人脸识别</li><li>**INSIGHT** : 慧眼人脸识别</li><li>**TELECOM** : 运营商三要素验证</li></ul>注：<ul><li>如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li><li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
1974
1944
  :rtype: list of str
1975
1945
  """
1976
1946
  return self._VerifyChannels
@@ -1981,11 +1951,7 @@ class AutoSignConfig(AbstractModel):
1981
1951
 
1982
1952
  @property
1983
1953
  def LicenseType(self):
1984
- r"""设置用户自动签合同的扣费方式。
1985
-
1986
- <ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul>
1987
-
1988
- 注：`该字段已经失效，请勿设置此参数。`
1954
+ r"""<p>设置用户自动签合同的扣费方式。</p><ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul><p>注：<code>该字段已经失效，请勿设置此参数。</code></p>
1989
1955
  :rtype: int
1990
1956
  """
1991
1957
  return self._LicenseType
@@ -1996,16 +1962,7 @@ class AutoSignConfig(AbstractModel):
1996
1962
 
1997
1963
  @property
1998
1964
  def JumpUrl(self):
1999
- r"""开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
2000
-
2001
- 注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
2002
-
2003
- 跳转场景：
2004
- <ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>
2005
- <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
2006
-
2007
- 成功结果返回：
2008
- 若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
1965
+ r"""<p>开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。</p><p>注：<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景：</p><ul><li>**贵方H5 -&gt; 腾讯电子签H5 -&gt; 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -&gt; 腾讯电子签H5 -&gt; 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。<code>APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。</code>APP拦截地址跳转可参考：<a href="https://qian.tencent.com/developers/company/openqianh5/#3-%E8%BF%94%E5%9B%9E%E5%BA%94%E7%94%A8jumpurl%E6%A0%BC%E5%BC%8F">返回应用JumpUrl格式</a></li></ul><p>成功结果返回：<br>若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：<code>appendResult=qian</code>。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&amp;result=success&amp;from=tencent_ess</p>
2009
1966
  :rtype: str
2010
1967
  """
2011
1968
  return self._JumpUrl
@@ -8944,7 +8901,7 @@ class CreateEmbedWebUrlRequest(AbstractModel):
8944
8901
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
8945
8902
  :param _EmbedType: <p>WEB嵌入资源类型，支持以下类型</p><p>枚举值：</p><ul><li><p>CREATE_SEAL： 生成创建印章的嵌入页面</p></li><li><p>CREATE_TEMPLATE： 生成创建模板的嵌入页面</p></li><li><p>MODIFY_TEMPLATE： 生成编辑模板的嵌入页面</p></li><li><p>CREATE_CONTRACT_DRAFT_COOPEDIT： 生成创建起草合同的嵌入页面</p></li><li><p>PREVIEW_TEMPLATE： 生成预览模板的嵌入页面</p></li><li><p>PREVIEW_SEAL_LIST： 生成预览印章列表的嵌入页面</p></li><li><p>PREVIEW_SEAL_DETAIL： 生成预览印章详情的嵌入页面</p></li><li><p>EXTEND_SERVICE： 生成高级签署能力的嵌入页面</p></li><li><p>PREVIEW_FLOW： 生成预览合同的嵌入页面（支持移动端）</p></li><li><p>PREVIEW_FLOW_DETAIL： 生成查看合同详情的嵌入页面（仅支持PC端）</p></li><li><p>CHANNEL_TEMPLATE： 生成应用模板库管理的嵌入页面（仅支持PC端）</p></li><li><p>CHANNEL_COMPONENT： 生成应用模板控件管理的嵌入页面（仅支持PC端）</p><p>注意： 不同的嵌入类型，操作人需要的权限项不同（权限配置可参考<a href="https://qian.tencent.com/document/61355">权限配置</a>）。 <table border="1"> <thead> <tr><th>EmbedType</th><th>权限</th></tr> </thead> <tbody> <tr><th>CREATE_SEAL</th><th>印章管理-添加印章</th></tr> <tr><th>CREATE_TEMPLATE</th><th>模板管理-创建模板</th></tr> <tr><th>MODIFY_TEMPLATE</th><th>模板管理-编辑模板</th></tr> <tr><th>CREATE_CONTRACT_DRAFT_COOPEDIT</th><th>合同管理-起草合同</th></tr> <tr><th>PREVIEW_TEMPLATE</th><th>拥有下面三种权限的一种就行<br> 模板管理-查询模板（本企业全部模板）<br> 模板管理-查询模板（本部门全部模板）<br> 模板管理-查询模板（本人创建模板）</th></tr> <tr><th>PREVIEW_SEAL_LIST</th><th>印章管理</th></tr> <tr><th>PREVIEW_SEAL_DETAIL</th><th>印章管理</th></tr> <tr><th>EXTEND_SERVICE</th><th>无要求</th></tr> <tr><th>PREVIEW_FLOW</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr> <tr><th>PREVIEW_FLOW_DETAIL</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr> <tr><th>CHANNEL_TEMPLATE</th><th>开发者中心-应用模板库管理</th></tr> <tr><th>CHANNEL_COMPONENT</th><th>开发者中心-应用模板控件管理</th></tr> </tbody> </table></p></li></ul>
8946
8903
  :type EmbedType: str
8947
- :param _BusinessId: <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为PREVIEW_SEAL_DETAIL，必填，取值为印章id。</li><li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。</li><li>为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。</li></ul><p>注意：</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi">查询转换任务状态</a> 来进行转换成PDF资源。</li><li>CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件，并且大小不能超过 10M。</li></ol>
8904
+ :param _BusinessId: <p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为PREVIEW_SEAL_DETAIL，必填，取值为印章id。</li><li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。</li><li>为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。</li></ul><p>注意：</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask">查询转换任务状态</a> 来进行转换成PDF资源。</li><li>CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件，并且大小不能超过 10M。</li></ol>
8948
8905
  :type BusinessId: str
8949
8906
  :param _Agent: <p>代理企业和员工的信息。<br><br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
8950
8907
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
@@ -8990,7 +8947,7 @@ class CreateEmbedWebUrlRequest(AbstractModel):
8990
8947
 
8991
8948
  @property
8992
8949
  def BusinessId(self):
8993
- r"""<p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为PREVIEW_SEAL_DETAIL，必填，取值为印章id。</li><li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。</li><li>为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。</li></ul><p>注意：</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi">查询转换任务状态</a> 来进行转换成PDF资源。</li><li>CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件，并且大小不能超过 10M。</li></ol>
8950
+ r"""<p>WEB嵌入的业务资源ID</p><p>当EmbedType取值</p><ul><li>为PREVIEW_SEAL_DETAIL，必填，取值为印章id。</li><li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。</li><li>为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li><li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。</li></ul><p>注意：</p><ol><li>CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask">创建文件转换任务</a> 和<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask">查询转换任务状态</a> 来进行转换成PDF资源。</li><li>CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件，并且大小不能超过 10M。</li></ol>
8994
8951
  :rtype: str
8995
8952
  """
8996
8953
  return self._BusinessId
@@ -13007,7 +12964,7 @@ class CreateFlowSignUrlRequest(AbstractModel):
13007
12964
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
13008
12965
  :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
13009
12966
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
13010
- :param _FlowApproverInfos: <p>流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有：</p><ol><li>RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。</li></ol><p>注：</p><ol><li>签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。</li><li>生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。</li></ol>
12967
+ :param _FlowApproverInfos: <p>流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有：</p><ol><li>RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。</li></ol><p>注：</p><ol><li>签署人<b>只能使用签名类型、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。</li><li>对于签名控件类型，支持手写签名、系统签名、个人印章等类型的签名方式，取决于合同发起时的设定。另外，签署的时候不支持拉取个人签署方已有签名图片资产，且创建的签名图片为一次性使用，不会保存为签署方个人资产。</li><li>生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。</li></ol>
13011
12968
  :type FlowApproverInfos: list of FlowCreateApprover
13012
12969
  :param _VideoVerifyTimesLimit: <p>用于指定进入视频签署的限制次数，次数取值范围：1 - 10，不设置则默认为5次，仅视频签署时生效。</p>
13013
12970
  :type VideoVerifyTimesLimit: int
@@ -13065,7 +13022,7 @@ class CreateFlowSignUrlRequest(AbstractModel):
13065
13022
 
13066
13023
  @property
13067
13024
  def FlowApproverInfos(self):
13068
- r"""<p>流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有：</p><ol><li>RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。</li></ol><p>注：</p><ol><li>签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。</li><li>生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。</li></ol>
13025
+ r"""<p>流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有：</p><ol><li>RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。</li></ol><p>注：</p><ol><li>签署人<b>只能使用签名类型、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。</li><li>对于签名控件类型，支持手写签名、系统签名、个人印章等类型的签名方式，取决于合同发起时的设定。另外，签署的时候不支持拉取个人签署方已有签名图片资产，且创建的签名图片为一次性使用，不会保存为签署方个人资产。</li><li>生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。</li></ol>
13069
13026
  :rtype: list of FlowCreateApprover
13070
13027
  """
13071
13028
  return self._FlowApproverInfos
@@ -23173,36 +23130,17 @@ class DescribeBillUsageDetailRequest(AbstractModel):
23173
23130
 
23174
23131
  def __init__(self):
23175
23132
  r"""
23176
- :param _StartTime: 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
23133
+ :param _StartTime: <p>查询开始时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<span style="color: red;">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</span></p><ul><li><p>正确示例：StartTime=20260901，EndTime=20260930。开始和结束日期都在 2026年9月，可以查询。</p></li><li><p>错误示例：StartTime=20260815，EndTime=20260915。开始日期在8月，结束日期在9月，属于跨月查询，不支持。</p></li></ul><p>参数格式：yyyyMMdd</p>
23177
23134
  :type StartTime: str
23178
- :param _EndTime: 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
23135
+ :param _EndTime: <p>查询结束时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<span style="color: red;">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</span></p><ul><li><p>正确示例：StartTime=20260901，EndTime=20260930。开始和结束日期都在 2026年9月，可以查询。</p></li><li><p>错误示例：StartTime=20260815，EndTime=20260915。开始日期在8月，结束日期在9月，属于跨月查询，不支持。</p></li></ul><p>参数格式：yyyyMMdd</p>
23179
23136
  :type EndTime: str
23180
- :param _Offset: 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
23137
+ :param _Offset: <p>指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0</p>
23181
23138
  :type Offset: int
23182
- :param _Limit: 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
23139
+ :param _Limit: <p>指定分页每页返回的数据条数，如果不传默认为 100，单页最大支持 100。</p>
23183
23140
  :type Limit: int
23184
- :param _QuotaType: 查询的套餐类型 （选填 ）不传则查询所有套餐；
23185
- 目前支持:
23186
- <ul>
23187
- <li>**CloudEnterprise**: 企业版合同</li>
23188
- <li>**SingleSignature**: 单方签章</li>
23189
- <li>**CloudProve**: 签署报告</li>
23190
- <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
23191
- <li>**ChannelWeCard**: 微工卡</li>
23192
- <li>**SignFlow**: 合同套餐</li>
23193
- <li>**SignFace**: 签署意愿（人脸识别）</li>
23194
- <li>**SignPassword**: 签署意愿（密码）</li>
23195
- <li>**SignSMS**: 签署意愿（短信）</li>
23196
- <li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
23197
- <li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
23198
- <li>**OrgEssAuth**: 签署企业实名</li>
23199
- <li>**FlowNotify**: 短信通知</li>
23200
- <li>**AuthService**: 企业工商信息查询</li>
23201
- <li>**NoAuthSign**: 形式签</li>
23202
- </ul>
23141
+ :param _QuotaType: <p>查询的套餐类型 （选填 ）不传则查询所有套餐；<br>目前支持:</p><ul><li>**CloudEnterprise**: 企业版合同</li><li>**SingleSignature**: 单方签章</li><li>**CloudProve**: 签署报告</li><li>**CloudOnlineSign**: 腾讯会议在线签约</li><li>**ChannelWeCard**: 微工卡</li><li>**SignFlow**: 合同套餐</li><li>**SignFace**: 签署意愿（人脸识别）</li><li>**SignPassword**: 签署意愿（密码）</li><li>**SignSMS**: 签署意愿（短信）</li><li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li><li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li><li>**OrgEssAuth**: 签署企业实名</li><li>**FlowNotify**: 短信通知</li><li>**AuthService**: 企业工商信息查询</li><li>**NoAuthSign**: 形式签</li></ul>
23203
23142
  :type QuotaType: str
23204
- :param _Agent: 代理企业和员工的信息。
23205
- 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
23143
+ :param _Agent: <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
23206
23144
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
23207
23145
  """
23208
23146
  self._StartTime = None
@@ -23214,7 +23152,7 @@ class DescribeBillUsageDetailRequest(AbstractModel):
23214
23152
 
23215
23153
  @property
23216
23154
  def StartTime(self):
23217
- r"""查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
23155
+ r"""<p>查询开始时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<span style="color: red;">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</span></p><ul><li><p>正确示例：StartTime=20260901，EndTime=20260930。开始和结束日期都在 2026年9月，可以查询。</p></li><li><p>错误示例：StartTime=20260815，EndTime=20260915。开始日期在8月，结束日期在9月，属于跨月查询，不支持。</p></li></ul><p>参数格式：yyyyMMdd</p>
23218
23156
  :rtype: str
23219
23157
  """
23220
23158
  return self._StartTime
@@ -23225,7 +23163,7 @@ class DescribeBillUsageDetailRequest(AbstractModel):
23225
23163
 
23226
23164
  @property
23227
23165
  def EndTime(self):
23228
- r"""查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
23166
+ r"""<p>查询结束时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<span style="color: red;">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</span></p><ul><li><p>正确示例：StartTime=20260901，EndTime=20260930。开始和结束日期都在 2026年9月，可以查询。</p></li><li><p>错误示例：StartTime=20260815，EndTime=20260915。开始日期在8月，结束日期在9月，属于跨月查询，不支持。</p></li></ul><p>参数格式：yyyyMMdd</p>
23229
23167
  :rtype: str
23230
23168
  """
23231
23169
  return self._EndTime
@@ -23236,7 +23174,7 @@ class DescribeBillUsageDetailRequest(AbstractModel):
23236
23174
 
23237
23175
  @property
23238
23176
  def Offset(self):
23239
- r"""指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
23177
+ r"""<p>指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0</p>
23240
23178
  :rtype: int
23241
23179
  """
23242
23180
  return self._Offset
@@ -23247,7 +23185,7 @@ class DescribeBillUsageDetailRequest(AbstractModel):
23247
23185
 
23248
23186
  @property
23249
23187
  def Limit(self):
23250
- r"""指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
23188
+ r"""<p>指定分页每页返回的数据条数，如果不传默认为 100，单页最大支持 100。</p>
23251
23189
  :rtype: int
23252
23190
  """
23253
23191
  return self._Limit
@@ -23258,25 +23196,7 @@ class DescribeBillUsageDetailRequest(AbstractModel):
23258
23196
 
23259
23197
  @property
23260
23198
  def QuotaType(self):
23261
- r"""查询的套餐类型 （选填 ）不传则查询所有套餐；
23262
- 目前支持:
23263
- <ul>
23264
- <li>**CloudEnterprise**: 企业版合同</li>
23265
- <li>**SingleSignature**: 单方签章</li>
23266
- <li>**CloudProve**: 签署报告</li>
23267
- <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
23268
- <li>**ChannelWeCard**: 微工卡</li>
23269
- <li>**SignFlow**: 合同套餐</li>
23270
- <li>**SignFace**: 签署意愿（人脸识别）</li>
23271
- <li>**SignPassword**: 签署意愿（密码）</li>
23272
- <li>**SignSMS**: 签署意愿（短信）</li>
23273
- <li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
23274
- <li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
23275
- <li>**OrgEssAuth**: 签署企业实名</li>
23276
- <li>**FlowNotify**: 短信通知</li>
23277
- <li>**AuthService**: 企业工商信息查询</li>
23278
- <li>**NoAuthSign**: 形式签</li>
23279
- </ul>
23199
+ r"""<p>查询的套餐类型 （选填 ）不传则查询所有套餐；<br>目前支持:</p><ul><li>**CloudEnterprise**: 企业版合同</li><li>**SingleSignature**: 单方签章</li><li>**CloudProve**: 签署报告</li><li>**CloudOnlineSign**: 腾讯会议在线签约</li><li>**ChannelWeCard**: 微工卡</li><li>**SignFlow**: 合同套餐</li><li>**SignFace**: 签署意愿（人脸识别）</li><li>**SignPassword**: 签署意愿（密码）</li><li>**SignSMS**: 签署意愿（短信）</li><li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li><li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li><li>**OrgEssAuth**: 签署企业实名</li><li>**FlowNotify**: 短信通知</li><li>**AuthService**: 企业工商信息查询</li><li>**NoAuthSign**: 形式签</li></ul>
23280
23200
  :rtype: str
23281
23201
  """
23282
23202
  return self._QuotaType
@@ -23287,8 +23207,7 @@ class DescribeBillUsageDetailRequest(AbstractModel):
23287
23207
 
23288
23208
  @property
23289
23209
  def Agent(self):
23290
- r"""代理企业和员工的信息。
23291
- 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
23210
+ r"""<p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。</p>
23292
23211
  :rtype: :class:`tencentcloud.ess.v20201111.models.Agent`
23293
23212
  """
23294
23213
  return self._Agent
@@ -23324,9 +23243,9 @@ class DescribeBillUsageDetailResponse(AbstractModel):
23324
23243
 
23325
23244
  def __init__(self):
23326
23245
  r"""
23327
- :param _Total: 总数
23246
+ :param _Total: <p>总数</p>
23328
23247
  :type Total: int
23329
- :param _Details: 消耗详情
23248
+ :param _Details: <p>消耗详情</p>
23330
23249
  :type Details: list of BillUsageDetail
23331
23250
  :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
23332
23251
  :type RequestId: str
@@ -23337,7 +23256,7 @@ class DescribeBillUsageDetailResponse(AbstractModel):
23337
23256
 
23338
23257
  @property
23339
23258
  def Total(self):
23340
- r"""总数
23259
+ r"""<p>总数</p>
23341
23260
  :rtype: int
23342
23261
  """
23343
23262
  return self._Total
@@ -23348,7 +23267,7 @@ class DescribeBillUsageDetailResponse(AbstractModel):
23348
23267
 
23349
23268
  @property
23350
23269
  def Details(self):
23351
- r"""消耗详情
23270
+ r"""<p>消耗详情</p>
23352
23271
  :rtype: list of BillUsageDetail
23353
23272
  """
23354
23273
  return self._Details
@@ -44205,22 +44124,17 @@ class SignComponentConfig(AbstractModel):
44205
44124
 
44206
44125
  def __init__(self):
44207
44126
  r"""
44208
- :param _HideDate: 签署控件默认属性配置，是否默认展示签署日期， 在页面中可以进行修改。
44209
-
44210
- - false 展示签署日期（默认）
44211
- - true 不展示签署日期
44212
- ![image](https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png)。
44127
+ :param _HideDate: <p>签署控件默认属性配置，是否默认展示签署日期， 在页面中可以进行修改。</p><ul><li>false 展示签署日期（默认）</li><li>true 不展示签署日期<br><img src="https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png" alt="image">。</li></ul>
44213
44128
  :type HideDate: bool
44129
+ :param _AddSignComponentUseSealSize: <p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件（SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL）时，「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值：</p><ul><li>0： 默认关闭，可开启。与现网一致</li><li>1： 关闭且置灰——按控件默认的4.2cm尺寸盖章，签署方无法开启开关</li><li>2： 默认开启且可修改——默认按印章实际尺寸盖章，签署方可手动关闭</li><li>3： 开启且置灰——强制按印章实际尺寸盖章，签署方不可修改</li></ul>
44130
+ :type AddSignComponentUseSealSize: int
44214
44131
  """
44215
44132
  self._HideDate = None
44133
+ self._AddSignComponentUseSealSize = None
44216
44134
 
44217
44135
  @property
44218
44136
  def HideDate(self):
44219
- r"""签署控件默认属性配置，是否默认展示签署日期， 在页面中可以进行修改。
44220
-
44221
- - false 展示签署日期（默认）
44222
- - true 不展示签署日期
44223
- ![image](https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png)。
44137
+ r"""<p>签署控件默认属性配置，是否默认展示签署日期， 在页面中可以进行修改。</p><ul><li>false 展示签署日期（默认）</li><li>true 不展示签署日期<br><img src="https://qcloudimg.tencent-cloud.cn/raw/448514412e2f69f6129425beda4ff568.png" alt="image">。</li></ul>
44224
44138
  :rtype: bool
44225
44139
  """
44226
44140
  return self._HideDate
@@ -44229,9 +44143,21 @@ class SignComponentConfig(AbstractModel):
44229
44143
  def HideDate(self, HideDate):
44230
44144
  self._HideDate = HideDate
44231
44145
 
44146
+ @property
44147
+ def AddSignComponentUseSealSize(self):
44148
+ r"""<p>【仅 SignBeanTag=1 时有效】 签署方自行添加签署印章类控件（SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL）时，「盖章区适配签署方印章尺寸」开关的控制策略</p><p>枚举值：</p><ul><li>0： 默认关闭，可开启。与现网一致</li><li>1： 关闭且置灰——按控件默认的4.2cm尺寸盖章，签署方无法开启开关</li><li>2： 默认开启且可修改——默认按印章实际尺寸盖章，签署方可手动关闭</li><li>3： 开启且置灰——强制按印章实际尺寸盖章，签署方不可修改</li></ul>
44149
+ :rtype: int
44150
+ """
44151
+ return self._AddSignComponentUseSealSize
44152
+
44153
+ @AddSignComponentUseSealSize.setter
44154
+ def AddSignComponentUseSealSize(self, AddSignComponentUseSealSize):
44155
+ self._AddSignComponentUseSealSize = AddSignComponentUseSealSize
44156
+
44232
44157
 
44233
44158
  def _deserialize(self, params):
44234
44159
  self._HideDate = params.get("HideDate")
44160
+ self._AddSignComponentUseSealSize = params.get("AddSignComponentUseSealSize")
44235
44161
  memeber_set = set(params.keys())
44236
44162
  for name, value in vars(self).items():
44237
44163
  property_name = name[1:]
@@ -46551,7 +46477,7 @@ class UploadFilesRequest(AbstractModel):
46551
46477
 
46552
46478
  def __init__(self):
46553
46479
  r"""
46554
- :param _BusinessType: <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值：</p><ul><li>TEMPLATE： 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT： 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可</li><li>SEAL： 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE： 此文件用于归档文件夹，文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE： 此文件用于上传营业执照，用于后续<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">创建企业认证链接</a>认证企业的时候提供营业执照，文件类型支持.jpg/.jpeg/.png，限制8M以内</li></ul>
46480
+ :param _BusinessType: <p>文件对应业务类型,可以选择的类型如下</p><p>枚举值：</p><ul><li>TEMPLATE： 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT： 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可</li><li>SEAL： 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE： 此文件用于归档文件夹，文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE： 此文件用于上传营业执照，用于后续<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">创建企业认证链接</a>认证企业的时候提供营业执照，文件类型支持.jpg/.jpeg/.png，限制8M以内</li></ul>
46555
46481
  :type BusinessType: str
46556
46482
  :param _Caller: <p>执行本接口操作的员工信息。其中OperatorId为必填字段，即用户的UserId。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
46557
46483
  :type Caller: :class:`tencentcloud.ess.v20201111.models.Caller`
@@ -46582,7 +46508,7 @@ class UploadFilesRequest(AbstractModel):
46582
46508
 
46583
46509
  @property
46584
46510
  def BusinessType(self):
46585
- r"""<p>文件对应业务类型,可以选择的类型如下</p><p>枚举值：</p><ul><li>TEMPLATE： 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT： 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可</li><li>SEAL： 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE： 此文件用于归档文件夹，文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE： 此文件用于上传营业执照，用于后续<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">创建企业认证链接</a>认证企业的时候提供营业执照，文件类型支持.jpg/.jpeg/.png，限制8M以内</li></ul>
46511
+ r"""<p>文件对应业务类型,可以选择的类型如下</p><p>枚举值：</p><ul><li>TEMPLATE： 此上传的文件用户生成合同模板，文件类型支持.pdf/.doc/.docx/.html格式，如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li><li>DOCUMENT： 此文件用来发起合同流程，文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html。如果上传的是非pdf文件，用来发起流程，还需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateFileConvertTask" target="_blank">创建文件转换任务</a>转换后得到的pdf文件才能用于发起合同接口。如果上传的文件不是用来发起合同，直接上传后使用返回的文件资源Id即可</li><li>SEAL： 此文件用于印章的生成，文件类型支持.jpg/.jpeg/.png</li><li>ARCHIVE： 此文件用于归档文件夹，文件类型支持.pdf/.zip格式</li><li>BUSINESSLICENSE： 此文件用于上传营业执照，用于后续<a href="https://qian.tencent.com/developers/companyApis/organizations/CreateOrganizationAuthUrl" target="_blank">创建企业认证链接</a>认证企业的时候提供营业执照，文件类型支持.jpg/.jpeg/.png，限制8M以内</li></ul>
46586
46512
  :rtype: str
46587
46513
  """
46588
46514
  return self._BusinessType
{tencentcloud_sdk_python_ess-3.1.166 → tencentcloud_sdk_python_ess-3.1.172}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: tencentcloud-sdk-python-ess
3
- Version: 3.1.166
3
+ Version: 3.1.172
4
4
  Summary: Tencent Cloud Ess SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3.6
17
17
  Classifier: Programming Language :: Python :: 3.7
18
- Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.166
18
+ Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.172
19
19
 
20
20
  ============================
21
21
  Tencent Cloud SDK for Python
tencentcloud_sdk_python_ess-3.1.172/tencentcloud_sdk_python_ess.egg-info/requires.txt ADDED
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.1.172
tencentcloud_sdk_python_ess-3.1.166/tencentcloud_sdk_python_ess.egg-info/requires.txt DELETED
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.1.166