tencentcloud-sdk-python-essbasic 3.1.172__py2.py3-none-any.whl → 3.1.174__py2.py3-none-any.whl
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.
- tencentcloud/__init__.py +1 -1
- tencentcloud/essbasic/v20210526/essbasic_client.py +53 -15
- tencentcloud/essbasic/v20210526/essbasic_client_async.py +53 -15
- tencentcloud/essbasic/v20210526/models.py +103 -76
- {tencentcloud_sdk_python_essbasic-3.1.172.dist-info → tencentcloud_sdk_python_essbasic-3.1.174.dist-info}/METADATA +2 -2
- {tencentcloud_sdk_python_essbasic-3.1.172.dist-info → tencentcloud_sdk_python_essbasic-3.1.174.dist-info}/RECORD +8 -8
- {tencentcloud_sdk_python_essbasic-3.1.172.dist-info → tencentcloud_sdk_python_essbasic-3.1.174.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_essbasic-3.1.172.dist-info → tencentcloud_sdk_python_essbasic-3.1.174.dist-info}/top_level.txt +0 -0
tencentcloud/__init__.py
CHANGED
|
@@ -2098,18 +2098,42 @@ class EssbasicClient(AbstractClient):
|
|
|
2098
2098
|
|
|
2099
2099
|
|
|
2100
2100
|
def CreateFileConvertTask(self, request):
|
|
2101
|
-
r"""
|
|
2102
|
-
<font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换服务（ChannelCreateConvertTaskApi）</a><br />
|
|
2103
|
-
前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。
|
|
2104
|
-
适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
|
|
2105
|
-
适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
|
|
2106
|
-
转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
2107
|
-
注:
|
|
2108
|
-
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
2109
|
-
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
2101
|
+
r"""创建文件转换任务
|
|
2110
2102
|
|
|
2111
|
-
|
|
2112
|
-
|
|
2103
|
+
### 1.1 接口说明
|
|
2104
|
+
|
|
2105
|
+
本接口用于创建文件转换任务，将以下类型的源文件转换为 PDF 文件：
|
|
2106
|
+
|
|
2107
|
+
`doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`
|
|
2108
|
+
|
|
2109
|
+
文件转换为异步耗时操作。任务创建成功后，可调用[查询文件转换任务状态](https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask)接口查询转换进度及结果。
|
|
2110
|
+
|
|
2111
|
+
### 1.2 前提条件
|
|
2112
|
+
|
|
2113
|
+
调用本接口前，请先通过[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)上传源文件，并获取文件对应的资源 ID（`ResourceId`）。
|
|
2114
|
+
|
|
2115
|
+
### 1.3 适用场景
|
|
2116
|
+
|
|
2117
|
+
- **Word 转 PDF**：已上传 Word 文件，需要先将其转换为 PDF，再用于发起合同。
|
|
2118
|
+
- **图片转 PDF**：已上传 JPG、PNG 等图片文件，需要先将其转换为 PDF，再用于发起合同。
|
|
2119
|
+
- **其他文件转 PDF**：将 Excel、HTML 或 TXT 文件转换为 PDF，以便预览或用于合同签署流程。
|
|
2120
|
+
|
|
2121
|
+
### 1.4 使用流程
|
|
2122
|
+
|
|
2123
|
+
1. 调用文件上传接口上传源文件，获取资源 ID。
|
|
2124
|
+
2. 调用 `CreateFileConvertTask`，使用资源 ID 创建转换任务。
|
|
2125
|
+
3. 保存接口返回的转换任务 ID。
|
|
2126
|
+
4. 调用 `DescribeFileConvertTask` 查询任务状态。
|
|
2127
|
+
5. 转换成功后，获取转换生成的 PDF 文件资源 ID。
|
|
2128
|
+
6. 使用转换后的 PDF 文件发起合同。
|
|
2129
|
+
|
|
2130
|
+
|
|
2131
|
+
|
|
2132
|
+
### 1.5 注意事项
|
|
2133
|
+
|
|
2134
|
+
1. 支持转换的文件格式为：`doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`。
|
|
2135
|
+
2. 文件转换需要一定时间，请勿在创建任务后立即使用转换结果，应通过任务状态查询接口确认转换成功。
|
|
2136
|
+
3. 建议在发起合同时开启文件预览，检查转换后的 PDF 是否符合预期，尤其需要关注页面排版、分页、字体及图片清晰度。
|
|
2113
2137
|
|
|
2114
2138
|
:param request: Request instance for CreateFileConvertTask.
|
|
2115
2139
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.CreateFileConvertTaskRequest`
|
|
@@ -2614,16 +2638,30 @@ class EssbasicClient(AbstractClient):
|
|
|
2614
2638
|
|
|
2615
2639
|
|
|
2616
2640
|
def CreateSignUrls(self, request):
|
|
2617
|
-
r"""
|
|
2641
|
+
r"""本接口用于获取跳转至腾讯电子签小程序的签署链接，签署人点击链接后即可<font color="red">跳转到腾讯电子签小程序</font>完成合同的查看、填写与签署等操作。
|
|
2618
2642
|
|
|
2619
|
-
|
|
2643
|
+
### 1.1 适用场景
|
|
2644
|
+
当需要签署人在贵方自有的 APP、小程序、H5、公众号等应用中发起或完成签署时，可通过此接口获取跳转至腾讯电子签小程序的签署链接，并结合企业自己的短信、页面按钮、二维码等方式触达签署人。
|
|
2645
|
+
跳转到小程序的实现，参考微信官方文档（分为<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/partner/openwxminiprogram">跳转电子签小程序配置</a>
|
|
2646
|
+
|
|
2647
|
+
### 1.2 注意事项
|
|
2648
|
+
<ul><li>1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署</li>
|
|
2649
|
+
<li>2. 签署链接的有效期为<font color="red">90天</font>，超过有效期链接不可用</li>
|
|
2650
|
+
<li>4. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）</li>
|
|
2651
|
+
<li>5. <font color="red">签署链接与签署人一一对应，仅限对应签署人本人打开</font>。例如给签署人A生成的链接只能A本人打开，其他人打开会提示无权限，不同签署人的链接不能混用</li></ul>
|
|
2652
|
+
|
|
2653
|
+
### 1.3 腾讯电子签小程序AppID
|
|
2654
|
+
其中小程序的原始Id如下，或者查看小程序信息自助获取。
|
|
2620
2655
|
|
|
2621
2656
|
| 小程序 | AppID | 原始ID |
|
|
2622
2657
|
| ------------ | ------------ | ------------ |
|
|
2623
2658
|
| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
2624
2659
|
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
2625
2660
|
|
|
2626
|
-
|
|
2661
|
+
<font color="red">注：如果客户在线上小程序环境中打开的是腾讯电子签的测试版本小程序（腾讯电子签Demo），需要联系其前端将跳转配置中小程序的 AppID 从 腾讯电子签Demo 更换为 腾讯电子签（正式版）。</font>
|
|
2662
|
+
|
|
2663
|
+
### 1.4主要使用场景EndPoint分类
|
|
2664
|
+
|
|
2627
2665
|
|
|
2628
2666
|
|EndPoint| 场景| 说明和示例|
|
|
2629
2667
|
| ---- | ---- | --- |
|
|
@@ -2904,7 +2942,7 @@ class EssbasicClient(AbstractClient):
|
|
|
2904
2942
|
|
|
2905
2943
|
def DescribeFileConvertTask(self, request):
|
|
2906
2944
|
r"""此接口（DescribeFileConvertTask）用来查询转换任务的状态。如需发起转换任务，请使用<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
2907
|
-
|
|
2945
|
+
|
|
2908
2946
|
前提条件：已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行文件转换，并得到了返回的转换任务Id。<br />
|
|
2909
2947
|
|
|
2910
2948
|
适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源ID。<br />
|
|
@@ -1802,18 +1802,42 @@ class EssbasicClient(AbstractClient):
|
|
|
1802
1802
|
opts: Dict = None,
|
|
1803
1803
|
) -> models.CreateFileConvertTaskResponse:
|
|
1804
1804
|
"""
|
|
1805
|
-
|
|
1806
|
-
<font color="red">原功能接口: </font><a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换服务（ChannelCreateConvertTaskApi）</a><br />
|
|
1807
|
-
前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。
|
|
1808
|
-
适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
|
|
1809
|
-
适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
|
|
1810
|
-
转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
1811
|
-
注:
|
|
1812
|
-
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
1813
|
-
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
1805
|
+
创建文件转换任务
|
|
1814
1806
|
|
|
1815
|
-
|
|
1816
|
-
|
|
1807
|
+
### 1.1 接口说明
|
|
1808
|
+
|
|
1809
|
+
本接口用于创建文件转换任务，将以下类型的源文件转换为 PDF 文件：
|
|
1810
|
+
|
|
1811
|
+
`doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`
|
|
1812
|
+
|
|
1813
|
+
文件转换为异步耗时操作。任务创建成功后，可调用[查询文件转换任务状态](https://qian.tencent.com/developers/partnerApis/files/DescribeFileConvertTask)接口查询转换进度及结果。
|
|
1814
|
+
|
|
1815
|
+
### 1.2 前提条件
|
|
1816
|
+
|
|
1817
|
+
调用本接口前，请先通过[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)上传源文件，并获取文件对应的资源 ID（`ResourceId`）。
|
|
1818
|
+
|
|
1819
|
+
### 1.3 适用场景
|
|
1820
|
+
|
|
1821
|
+
- **Word 转 PDF**：已上传 Word 文件，需要先将其转换为 PDF，再用于发起合同。
|
|
1822
|
+
- **图片转 PDF**：已上传 JPG、PNG 等图片文件，需要先将其转换为 PDF，再用于发起合同。
|
|
1823
|
+
- **其他文件转 PDF**：将 Excel、HTML 或 TXT 文件转换为 PDF，以便预览或用于合同签署流程。
|
|
1824
|
+
|
|
1825
|
+
### 1.4 使用流程
|
|
1826
|
+
|
|
1827
|
+
1. 调用文件上传接口上传源文件，获取资源 ID。
|
|
1828
|
+
2. 调用 `CreateFileConvertTask`，使用资源 ID 创建转换任务。
|
|
1829
|
+
3. 保存接口返回的转换任务 ID。
|
|
1830
|
+
4. 调用 `DescribeFileConvertTask` 查询任务状态。
|
|
1831
|
+
5. 转换成功后，获取转换生成的 PDF 文件资源 ID。
|
|
1832
|
+
6. 使用转换后的 PDF 文件发起合同。
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
### 1.5 注意事项
|
|
1837
|
+
|
|
1838
|
+
1. 支持转换的文件格式为：`doc`、`docx`、`xls`、`xlsx`、`html`、`jpg`、`jpeg`、`png`、`bmp`、`txt`。
|
|
1839
|
+
2. 文件转换需要一定时间，请勿在创建任务后立即使用转换结果，应通过任务状态查询接口确认转换成功。
|
|
1840
|
+
3. 建议在发起合同时开启文件预览，检查转换后的 PDF 是否符合预期，尤其需要关注页面排版、分页、字体及图片清晰度。
|
|
1817
1841
|
"""
|
|
1818
1842
|
|
|
1819
1843
|
kwargs = {}
|
|
@@ -2258,16 +2282,30 @@ class EssbasicClient(AbstractClient):
|
|
|
2258
2282
|
opts: Dict = None,
|
|
2259
2283
|
) -> models.CreateSignUrlsResponse:
|
|
2260
2284
|
"""
|
|
2261
|
-
|
|
2285
|
+
本接口用于获取跳转至腾讯电子签小程序的签署链接，签署人点击链接后即可<font color="red">跳转到腾讯电子签小程序</font>完成合同的查看、填写与签署等操作。
|
|
2262
2286
|
|
|
2263
|
-
|
|
2287
|
+
### 1.1 适用场景
|
|
2288
|
+
当需要签署人在贵方自有的 APP、小程序、H5、公众号等应用中发起或完成签署时，可通过此接口获取跳转至腾讯电子签小程序的签署链接，并结合企业自己的短信、页面按钮、二维码等方式触达签署人。
|
|
2289
|
+
跳转到小程序的实现，参考微信官方文档（分为<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/partner/openwxminiprogram">跳转电子签小程序配置</a>
|
|
2290
|
+
|
|
2291
|
+
### 1.2 注意事项
|
|
2292
|
+
<ul><li>1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署</li>
|
|
2293
|
+
<li>2. 签署链接的有效期为<font color="red">90天</font>，超过有效期链接不可用</li>
|
|
2294
|
+
<li>4. <font color="red">生成的链路后面不能再增加参数</font>（会出现覆盖链接中已有参数导致错误）</li>
|
|
2295
|
+
<li>5. <font color="red">签署链接与签署人一一对应，仅限对应签署人本人打开</font>。例如给签署人A生成的链接只能A本人打开，其他人打开会提示无权限，不同签署人的链接不能混用</li></ul>
|
|
2296
|
+
|
|
2297
|
+
### 1.3 腾讯电子签小程序AppID
|
|
2298
|
+
其中小程序的原始Id如下，或者查看小程序信息自助获取。
|
|
2264
2299
|
|
|
2265
2300
|
| 小程序 | AppID | 原始ID |
|
|
2266
2301
|
| ------------ | ------------ | ------------ |
|
|
2267
2302
|
| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
2268
2303
|
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
2269
2304
|
|
|
2270
|
-
|
|
2305
|
+
<font color="red">注：如果客户在线上小程序环境中打开的是腾讯电子签的测试版本小程序（腾讯电子签Demo），需要联系其前端将跳转配置中小程序的 AppID 从 腾讯电子签Demo 更换为 腾讯电子签（正式版）。</font>
|
|
2306
|
+
|
|
2307
|
+
### 1.4主要使用场景EndPoint分类
|
|
2308
|
+
|
|
2271
2309
|
|
|
2272
2310
|
|EndPoint| 场景| 说明和示例|
|
|
2273
2311
|
| ---- | ---- | --- |
|
|
@@ -2498,7 +2536,7 @@ class EssbasicClient(AbstractClient):
|
|
|
2498
2536
|
) -> models.DescribeFileConvertTaskResponse:
|
|
2499
2537
|
"""
|
|
2500
2538
|
此接口（DescribeFileConvertTask）用来查询转换任务的状态。如需发起转换任务，请使用<a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
2501
|
-
|
|
2539
|
+
|
|
2502
2540
|
前提条件：已调用 <a href="https://qian.tencent.com/developers/partnerApis/files/CreateFileConvertTask" target="_blank">创建文件转换任务接口</a>进行文件转换，并得到了返回的转换任务Id。<br />
|
|
2503
2541
|
|
|
2504
2542
|
适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源ID。<br />
|
|
@@ -6898,38 +6898,38 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
6898
6898
|
:type IdCardNumber: str
|
|
6899
6899
|
:param _SealName: <p>电子印章名字，1-50个中文字符<br>注:<code>同一企业下电子印章名字不能相同</code></p>
|
|
6900
6900
|
:type SealName: str
|
|
6901
|
-
:param _SealImage: <p>电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。</p>
|
|
6902
|
-
:type SealImage: str
|
|
6903
6901
|
:param _Operator: <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
|
|
6904
6902
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
6905
6903
|
:param _IdCardType: <p>证件类型，支持以下类型</p><ul><li>ID_CARD : 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li><li>OTHER_CARD_TYPE : 其他</li></ul><p>注: <code>其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。</code></p>
|
|
6906
6904
|
:type IdCardType: str
|
|
6907
|
-
:param _SealImageCompress: <p>是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。</p>
|
|
6908
|
-
:type SealImageCompress: bool
|
|
6909
6905
|
:param _Mobile: <p>手机号码；当需要开通自动签时，该参数必传</p>
|
|
6910
6906
|
:type Mobile: str
|
|
6911
|
-
:param _EnableAutoSign: <p>该字段已不再使用</p>
|
|
6912
|
-
:type EnableAutoSign: bool
|
|
6913
|
-
:param _LicenseType: <p>设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减</p>
|
|
6914
|
-
:type LicenseType: int
|
|
6915
|
-
:param _SceneKey: <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
6916
|
-
:type SceneKey: str
|
|
6917
6907
|
:param _FileId: <p>印章图片文件 id取值：填写的FileId通过UploadFiles接口上传文件获取。</p>
|
|
6918
6908
|
:type FileId: str
|
|
6909
|
+
:param _SceneKey: <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
6910
|
+
:type SceneKey: str
|
|
6911
|
+
:param _LicenseType: <p>该字段已不再使用，设置不生效。</p>
|
|
6912
|
+
:type LicenseType: int
|
|
6913
|
+
:param _SealImage: <p>该字段已不再使用，请使用 FileId 参数代替。</p>
|
|
6914
|
+
:type SealImage: str
|
|
6915
|
+
:param _EnableAutoSign: <p>该字段已不再使用，设置不生效。</p>
|
|
6916
|
+
:type EnableAutoSign: bool
|
|
6917
|
+
:param _SealImageCompress: <p>该字段已不再使用，设置不生效。</p>
|
|
6918
|
+
:type SealImageCompress: bool
|
|
6919
6919
|
"""
|
|
6920
6920
|
self._Agent = None
|
|
6921
6921
|
self._UserName = None
|
|
6922
6922
|
self._IdCardNumber = None
|
|
6923
6923
|
self._SealName = None
|
|
6924
|
-
self._SealImage = None
|
|
6925
6924
|
self._Operator = None
|
|
6926
6925
|
self._IdCardType = None
|
|
6927
|
-
self._SealImageCompress = None
|
|
6928
6926
|
self._Mobile = None
|
|
6929
|
-
self._EnableAutoSign = None
|
|
6930
|
-
self._LicenseType = None
|
|
6931
|
-
self._SceneKey = None
|
|
6932
6927
|
self._FileId = None
|
|
6928
|
+
self._SceneKey = None
|
|
6929
|
+
self._LicenseType = None
|
|
6930
|
+
self._SealImage = None
|
|
6931
|
+
self._EnableAutoSign = None
|
|
6932
|
+
self._SealImageCompress = None
|
|
6933
6933
|
|
|
6934
6934
|
@property
|
|
6935
6935
|
def Agent(self):
|
|
@@ -6975,17 +6975,6 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
6975
6975
|
def SealName(self, SealName):
|
|
6976
6976
|
self._SealName = SealName
|
|
6977
6977
|
|
|
6978
|
-
@property
|
|
6979
|
-
def SealImage(self):
|
|
6980
|
-
r"""<p>电子印章图片base64编码，大小不超过10M（原始图片不超过5M），只支持PNG或JPG图片格式。</p>
|
|
6981
|
-
:rtype: str
|
|
6982
|
-
"""
|
|
6983
|
-
return self._SealImage
|
|
6984
|
-
|
|
6985
|
-
@SealImage.setter
|
|
6986
|
-
def SealImage(self, SealImage):
|
|
6987
|
-
self._SealImage = SealImage
|
|
6988
|
-
|
|
6989
6978
|
@property
|
|
6990
6979
|
def Operator(self):
|
|
6991
6980
|
r"""<p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。</code></p>
|
|
@@ -7008,17 +6997,6 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7008
6997
|
def IdCardType(self, IdCardType):
|
|
7009
6998
|
self._IdCardType = IdCardType
|
|
7010
6999
|
|
|
7011
|
-
@property
|
|
7012
|
-
def SealImageCompress(self):
|
|
7013
|
-
r"""<p>是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。</p>
|
|
7014
|
-
:rtype: bool
|
|
7015
|
-
"""
|
|
7016
|
-
return self._SealImageCompress
|
|
7017
|
-
|
|
7018
|
-
@SealImageCompress.setter
|
|
7019
|
-
def SealImageCompress(self, SealImageCompress):
|
|
7020
|
-
self._SealImageCompress = SealImageCompress
|
|
7021
|
-
|
|
7022
7000
|
@property
|
|
7023
7001
|
def Mobile(self):
|
|
7024
7002
|
r"""<p>手机号码；当需要开通自动签时，该参数必传</p>
|
|
@@ -7031,52 +7009,86 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7031
7009
|
self._Mobile = Mobile
|
|
7032
7010
|
|
|
7033
7011
|
@property
|
|
7034
|
-
def
|
|
7035
|
-
|
|
7036
|
-
|
|
7037
|
-
r"""<p>该字段已不再使用</p>
|
|
7038
|
-
:rtype: bool
|
|
7012
|
+
def FileId(self):
|
|
7013
|
+
r"""<p>印章图片文件 id取值：填写的FileId通过UploadFiles接口上传文件获取。</p>
|
|
7014
|
+
:rtype: str
|
|
7039
7015
|
"""
|
|
7040
|
-
return self.
|
|
7016
|
+
return self._FileId
|
|
7041
7017
|
|
|
7042
|
-
@
|
|
7043
|
-
def
|
|
7044
|
-
|
|
7018
|
+
@FileId.setter
|
|
7019
|
+
def FileId(self, FileId):
|
|
7020
|
+
self._FileId = FileId
|
|
7045
7021
|
|
|
7046
|
-
|
|
7022
|
+
@property
|
|
7023
|
+
def SceneKey(self):
|
|
7024
|
+
r"""<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
|
|
7025
|
+
:rtype: str
|
|
7026
|
+
"""
|
|
7027
|
+
return self._SceneKey
|
|
7028
|
+
|
|
7029
|
+
@SceneKey.setter
|
|
7030
|
+
def SceneKey(self, SceneKey):
|
|
7031
|
+
self._SceneKey = SceneKey
|
|
7047
7032
|
|
|
7048
7033
|
@property
|
|
7049
7034
|
def LicenseType(self):
|
|
7050
|
-
|
|
7035
|
+
warnings.warn("parameter `LicenseType` is deprecated", DeprecationWarning)
|
|
7036
|
+
|
|
7037
|
+
r"""<p>该字段已不再使用，设置不生效。</p>
|
|
7051
7038
|
:rtype: int
|
|
7052
7039
|
"""
|
|
7053
7040
|
return self._LicenseType
|
|
7054
7041
|
|
|
7055
7042
|
@LicenseType.setter
|
|
7056
7043
|
def LicenseType(self, LicenseType):
|
|
7044
|
+
warnings.warn("parameter `LicenseType` is deprecated", DeprecationWarning)
|
|
7045
|
+
|
|
7057
7046
|
self._LicenseType = LicenseType
|
|
7058
7047
|
|
|
7059
7048
|
@property
|
|
7060
|
-
def
|
|
7061
|
-
|
|
7049
|
+
def SealImage(self):
|
|
7050
|
+
warnings.warn("parameter `SealImage` is deprecated", DeprecationWarning)
|
|
7051
|
+
|
|
7052
|
+
r"""<p>该字段已不再使用，请使用 FileId 参数代替。</p>
|
|
7062
7053
|
:rtype: str
|
|
7063
7054
|
"""
|
|
7064
|
-
return self.
|
|
7055
|
+
return self._SealImage
|
|
7065
7056
|
|
|
7066
|
-
@
|
|
7067
|
-
def
|
|
7068
|
-
|
|
7057
|
+
@SealImage.setter
|
|
7058
|
+
def SealImage(self, SealImage):
|
|
7059
|
+
warnings.warn("parameter `SealImage` is deprecated", DeprecationWarning)
|
|
7060
|
+
|
|
7061
|
+
self._SealImage = SealImage
|
|
7069
7062
|
|
|
7070
7063
|
@property
|
|
7071
|
-
def
|
|
7072
|
-
|
|
7073
|
-
|
|
7064
|
+
def EnableAutoSign(self):
|
|
7065
|
+
warnings.warn("parameter `EnableAutoSign` is deprecated", DeprecationWarning)
|
|
7066
|
+
|
|
7067
|
+
r"""<p>该字段已不再使用，设置不生效。</p>
|
|
7068
|
+
:rtype: bool
|
|
7074
7069
|
"""
|
|
7075
|
-
return self.
|
|
7070
|
+
return self._EnableAutoSign
|
|
7076
7071
|
|
|
7077
|
-
@
|
|
7078
|
-
def
|
|
7079
|
-
|
|
7072
|
+
@EnableAutoSign.setter
|
|
7073
|
+
def EnableAutoSign(self, EnableAutoSign):
|
|
7074
|
+
warnings.warn("parameter `EnableAutoSign` is deprecated", DeprecationWarning)
|
|
7075
|
+
|
|
7076
|
+
self._EnableAutoSign = EnableAutoSign
|
|
7077
|
+
|
|
7078
|
+
@property
|
|
7079
|
+
def SealImageCompress(self):
|
|
7080
|
+
warnings.warn("parameter `SealImageCompress` is deprecated", DeprecationWarning)
|
|
7081
|
+
|
|
7082
|
+
r"""<p>该字段已不再使用，设置不生效。</p>
|
|
7083
|
+
:rtype: bool
|
|
7084
|
+
"""
|
|
7085
|
+
return self._SealImageCompress
|
|
7086
|
+
|
|
7087
|
+
@SealImageCompress.setter
|
|
7088
|
+
def SealImageCompress(self, SealImageCompress):
|
|
7089
|
+
warnings.warn("parameter `SealImageCompress` is deprecated", DeprecationWarning)
|
|
7090
|
+
|
|
7091
|
+
self._SealImageCompress = SealImageCompress
|
|
7080
7092
|
|
|
7081
7093
|
|
|
7082
7094
|
def _deserialize(self, params):
|
|
@@ -7086,17 +7098,17 @@ class ChannelCreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
7086
7098
|
self._UserName = params.get("UserName")
|
|
7087
7099
|
self._IdCardNumber = params.get("IdCardNumber")
|
|
7088
7100
|
self._SealName = params.get("SealName")
|
|
7089
|
-
self._SealImage = params.get("SealImage")
|
|
7090
7101
|
if params.get("Operator") is not None:
|
|
7091
7102
|
self._Operator = UserInfo()
|
|
7092
7103
|
self._Operator._deserialize(params.get("Operator"))
|
|
7093
7104
|
self._IdCardType = params.get("IdCardType")
|
|
7094
|
-
self._SealImageCompress = params.get("SealImageCompress")
|
|
7095
7105
|
self._Mobile = params.get("Mobile")
|
|
7096
|
-
self._EnableAutoSign = params.get("EnableAutoSign")
|
|
7097
|
-
self._LicenseType = params.get("LicenseType")
|
|
7098
|
-
self._SceneKey = params.get("SceneKey")
|
|
7099
7106
|
self._FileId = params.get("FileId")
|
|
7107
|
+
self._SceneKey = params.get("SceneKey")
|
|
7108
|
+
self._LicenseType = params.get("LicenseType")
|
|
7109
|
+
self._SealImage = params.get("SealImage")
|
|
7110
|
+
self._EnableAutoSign = params.get("EnableAutoSign")
|
|
7111
|
+
self._SealImageCompress = params.get("SealImageCompress")
|
|
7100
7112
|
memeber_set = set(params.keys())
|
|
7101
7113
|
for name, value in vars(self).items():
|
|
7102
7114
|
property_name = name[1:]
|
|
@@ -9139,9 +9151,9 @@ class ChannelDescribeBillUsageDetailRequest(AbstractModel):
|
|
|
9139
9151
|
r"""
|
|
9140
9152
|
:param _Agent: <p>关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li></ul>第三方平台子客企业必须已经经过实名认证
|
|
9141
9153
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
9142
|
-
:param _StartTime: <p>查询开始时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<
|
|
9154
|
+
:param _StartTime: <p>查询开始时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<font color="red">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</font></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>
|
|
9143
9155
|
:type StartTime: str
|
|
9144
|
-
:param _EndTime: <p>查询结束时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<
|
|
9156
|
+
:param _EndTime: <p>查询结束时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<font color="red">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</font></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>
|
|
9145
9157
|
:type EndTime: str
|
|
9146
9158
|
: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></ul>
|
|
9147
9159
|
:type QuotaType: str
|
|
@@ -9170,7 +9182,7 @@ class ChannelDescribeBillUsageDetailRequest(AbstractModel):
|
|
|
9170
9182
|
|
|
9171
9183
|
@property
|
|
9172
9184
|
def StartTime(self):
|
|
9173
|
-
r"""<p>查询开始时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<
|
|
9185
|
+
r"""<p>查询开始时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<font color="red">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</font></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>
|
|
9174
9186
|
:rtype: str
|
|
9175
9187
|
"""
|
|
9176
9188
|
return self._StartTime
|
|
@@ -9181,7 +9193,7 @@ class ChannelDescribeBillUsageDetailRequest(AbstractModel):
|
|
|
9181
9193
|
|
|
9182
9194
|
@property
|
|
9183
9195
|
def EndTime(self):
|
|
9184
|
-
r"""<p>查询结束时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<
|
|
9196
|
+
r"""<p>查询结束时间字符串，格式为yyyyMMdd，时间跨度不能大于31天。<font color="red">注意：从 2026年10月10日起，开始日期和结束日期必须在同一个自然月内，不支持跨月查询。</font></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>
|
|
9185
9197
|
:rtype: str
|
|
9186
9198
|
"""
|
|
9187
9199
|
return self._EndTime
|
|
@@ -12041,7 +12053,7 @@ class Component(AbstractModel):
|
|
|
12041
12053
|
:type ComponentPosX: float
|
|
12042
12054
|
:param _ComponentPosY: <p><strong>在绝对定位方式下</strong>，可以指定控件纵向位置的位置，单位为pt（点）。</p>
|
|
12043
12055
|
:type ComponentPosY: float
|
|
12044
|
-
:param _ComponentExtra: <p><strong>在所有的定位方式下</strong>，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li><li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗：true/false</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12,"Bold":false}</code><p><font color="red">ComponentType为DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12}</code><p><font color="red">ComponentType为WATERMARK时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>Opacity</b>： 透明度，范围0 :1</li><li> <b>Rotate</b>： 水印旋转角度，范围0 :359</li><li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li><li> <b>Position</b>： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li><li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>：<code>"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"</code><p><font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：</p><ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>，支持以下参数：</p><ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以<strong>ComponentTypeLimit</strong>参数控制签署方式</p><ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>：<code>{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}</code>印章的对应关系参考下图<br><br><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型<ul><li> <b>OFFICIAL</b> : 企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>：<code>{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li><li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li><li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）<b>参数样例</b>： <code>"{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：</p><ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul><b>参数样例</b>：<code>"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"</code><p><font color="red">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：</p><ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li><li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul><b>参数样例</b>：<code>{"Rotate":-30,"RotateRelation":"Component_Id1"}</code><p><font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：</p><ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul><b>参数样例</b>：<code>{"Opacity":0.7}</code><p><font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：</p><ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul><b>参数样例</b>：<code>{"UseSealSize":true}</code><p><font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：</p><ul><li> <b>Values</b>：签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li></ul><b>参数样例</b>：<code>{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。<b>参数样例</b>：<code>"{"IgnoreKeywordError":1}"</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>，支持以下参数：</p><ul><li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li><b>参数样例</b>：<br><code>{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>ChildrenComponent结构体定义:<table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td></tr><tr> <td>ComponentValue</td> <td>string</td> <td>子控件值（签署方不可设置）</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table><b>参数样例</b>：<pre>{ "ChildrenComponents": [ { "ComponentType": "SIGN_SIGNATURE", "ComponentName": "个人签名", "Placeholder": "请签名", "ComponentOffsetX": 10, "ComponentOffsetY": 30, "ComponentWidth": 119, "ComponentHeight": 43, "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}" }, { "ComponentType": "SIGN_SELECTOR", "ComponentName": "是否同意此协议", "Placeholder": "", "ComponentOffsetX": 50, "ComponentOffsetY": 130, "ComponentWidth": 120, "ComponentHeight": 43, "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}" }, { "ComponentType": "SIGN_MULTI_LINE_TEXT", "ComponentName": "批注附言", "Placeholder": "", "ComponentOffsetX": 150, "ComponentOffsetY": 300, "ComponentWidth": 200, "ComponentHeight": 86, "ComponentExtra": "" } ]}</pre></ul>
|
|
12056
|
+
:param _ComponentExtra: <p><strong>在所有的定位方式下</strong>，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li><li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗：true/false</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12,"Bold":false}</code><p><font color="red">ComponentType为DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12}</code><p><font color="red">ComponentType为WATERMARK时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>Opacity</b>： 透明度，范围0 :1</li><li> <b>Rotate</b>： 水印旋转角度，范围0 :359</li><li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li><li> <b>Position</b>： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li><li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>：<code>"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"</code><p><font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：</p><ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>，支持以下参数：</p><ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以<strong>ComponentTypeLimit</strong>参数控制签署方式</p><ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>：<code>{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}</code>印章的对应关系参考下图<br><br><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型<ul><li> <b>OFFICIAL</b> : 企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>：<code>{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li><li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”，”yyyy m d HH:MM:SS”，”yyyy/m/d HH:MM:SS”，”yyyy-m-d HH:MM:SS”，”yyyy.m.d HH:MM:SS”。</li><li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）<b>参数样例</b>： <code>"{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：</p><ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul><b>参数样例</b>：<code>"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"</code><p><font color="red">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：</p><ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li><li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul><b>参数样例</b>：<code>{"Rotate":-30,"RotateRelation":"Component_Id1"}</code><p><font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：</p><ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul><b>参数样例</b>：<code>{"Opacity":0.7}</code><p><font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：</p><ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul><b>参数样例</b>：<code>{"UseSealSize":true}</code><p><font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：</p><ul><li> <b>Values</b>：签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li><li> <b>SignMethod</b>：签署方式，目前支持1-词组拼接方式</li></ul><b>参数样例</b>：<code>{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"],"SignMethod":1}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。<b>参数样例</b>：<code>"{"IgnoreKeywordError":1}"</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>，支持以下参数：</p><ul><li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li><b>参数样例</b>：<br><code>{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>ChildrenComponent结构体定义:<table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td></tr><tr> <td>ComponentValue</td> <td>string</td> <td>子控件值（签署方不可设置）</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table><b>参数样例</b>：<pre>{ "ChildrenComponents": [ { "ComponentType": "SIGN_SIGNATURE", "ComponentName": "个人签名", "Placeholder": "请签名", "ComponentOffsetX": 10, "ComponentOffsetY": 30, "ComponentWidth": 119, "ComponentHeight": 43, "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}" }, { "ComponentType": "SIGN_SELECTOR", "ComponentName": "是否同意此协议", "Placeholder": "", "ComponentOffsetX": 50, "ComponentOffsetY": 130, "ComponentWidth": 120, "ComponentHeight": 43, "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}" }, { "ComponentType": "SIGN_MULTI_LINE_TEXT", "ComponentName": "批注附言", "Placeholder": "", "ComponentOffsetX": 150, "ComponentOffsetY": 300, "ComponentWidth": 200, "ComponentHeight": 86, "ComponentExtra": "" } ]}</pre></ul>
|
|
12045
12057
|
:type ComponentExtra: str
|
|
12046
12058
|
:param _ComponentValue: <p>控件填充vaule，ComponentType和传入值类型对应关系：</p><ul><li> <b>TEXT</b> : 文本内容</li><li> <b>MULTI_LINE_TEXT</b> : 文本内容， 可以用 \n 来控制换行位置</li><li> <b>CHECK_BOX</b> : true/false</li><li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId，需要通过UploadFiles接口上传获取</li><li> <b>SELECTOR</b> : 选项值</li><li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li><li> <b>DATE</b> : 格式化：xxxx年xx月xx日（例如：2024年05月28日）</li><li> <b>SIGN_SEAL</b> : 印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li><li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID，于控制台查询获取，[点击查看在控制上的位置](https://qcloudimg.tencent-cloud.cn/raw/cd403a5b949fce197fd9e88bb6db1517.png)</li></ul><p><b>控件值约束说明</b>：</p><table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr><tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>注： <code>部分特殊控件需要在控制台配置模板形式创建</code>
|
|
12047
12059
|
:type ComponentValue: str
|
|
@@ -12234,7 +12246,7 @@ class Component(AbstractModel):
|
|
|
12234
12246
|
|
|
12235
12247
|
@property
|
|
12236
12248
|
def ComponentExtra(self):
|
|
12237
|
-
r"""<p><strong>在所有的定位方式下</strong>，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li><li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗：true/false</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12,"Bold":false}</code><p><font color="red">ComponentType为DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12}</code><p><font color="red">ComponentType为WATERMARK时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>Opacity</b>： 透明度，范围0 :1</li><li> <b>Rotate</b>： 水印旋转角度，范围0 :359</li><li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li><li> <b>Position</b>： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li><li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>：<code>"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"</code><p><font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：</p><ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>，支持以下参数：</p><ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以<strong>ComponentTypeLimit</strong>参数控制签署方式</p><ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>：<code>{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}</code>印章的对应关系参考下图<br><br><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型<ul><li> <b>OFFICIAL</b> : 企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>：<code>{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li><li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li><li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）<b>参数样例</b>： <code>"{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：</p><ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul><b>参数样例</b>：<code>"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"</code><p><font color="red">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：</p><ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li><li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul><b>参数样例</b>：<code>{"Rotate":-30,"RotateRelation":"Component_Id1"}</code><p><font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：</p><ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul><b>参数样例</b>：<code>{"Opacity":0.7}</code><p><font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：</p><ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul><b>参数样例</b>：<code>{"UseSealSize":true}</code><p><font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：</p><ul><li> <b>Values</b>：签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li></ul><b>参数样例</b>：<code>{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。<b>参数样例</b>：<code>"{"IgnoreKeywordError":1}"</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>，支持以下参数：</p><ul><li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li><b>参数样例</b>：<br><code>{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>ChildrenComponent结构体定义:<table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td></tr><tr> <td>ComponentValue</td> <td>string</td> <td>子控件值（签署方不可设置）</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table><b>参数样例</b>：<pre>{ "ChildrenComponents": [ { "ComponentType": "SIGN_SIGNATURE", "ComponentName": "个人签名", "Placeholder": "请签名", "ComponentOffsetX": 10, "ComponentOffsetY": 30, "ComponentWidth": 119, "ComponentHeight": 43, "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}" }, { "ComponentType": "SIGN_SELECTOR", "ComponentName": "是否同意此协议", "Placeholder": "", "ComponentOffsetX": 50, "ComponentOffsetY": 130, "ComponentWidth": 120, "ComponentHeight": 43, "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}" }, { "ComponentType": "SIGN_MULTI_LINE_TEXT", "ComponentName": "批注附言", "Placeholder": "", "ComponentOffsetX": 150, "ComponentOffsetY": 300, "ComponentWidth": 200, "ComponentHeight": 86, "ComponentExtra": "" } ]}</pre></ul>
|
|
12249
|
+
r"""<p><strong>在所有的定位方式下</strong>，控件的扩展参数，为<font color="red">JSON格式</font>，不同类型的控件会有部分非通用参数。</p><p><font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li><li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li><li> <b>Bold</b>是否加粗：true/false</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12,"Bold":false}</code><p><font color="red">ComponentType为DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li></ul><b>参数样例</b>：<code>{"FontColor":"255,0,0","FontSize":12}</code><p><font color="red">ComponentType为WATERMARK时</font>，支持以下参数：</p><ul><li> <b>Font</b>：目前只支持黑体、宋体、仿宋</li><li> <b>FontSize</b>： 范围6 :72</li><li> <b>Opacity</b>： 透明度，范围0 :1</li><li> <b>Rotate</b>： 水印旋转角度，范围0 :359</li><li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li><li> <b>Position</b>： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中</li><li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul><b>参数样例</b>：<code>"{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"</code><p><font color="red">ComponentType为FILL_IMAGE时</font>，支持以下参数：</p><ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li><li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul><p><font color="red">ComponentType为SELECTOR时</font>，支持以下参数：</p><ul><li> <b>WordWrap</b>：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成</li></ul><p><font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>，可以<strong>ComponentTypeLimit</strong>参数控制签署方式</p><ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li><li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li><li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li><li> <b>ESIGN</b> : 个人印章类型</li><li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li><li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul><b>参考样例</b>：<code>{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}</code>印章的对应关系参考下图<br><br><font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型<ul><li> <b>OFFICIAL</b> : 企业公章</li><li> <b>CONTRACT</b> : 合同专用章</li><li> <b>FINANCE</b> : 财务专用章</li><li> <b>PERSONNEL</b> : 人事专用章</li><li> <b>OTHER</b> : 其他</li></ul><b>参考样例</b>：<code>{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}</code> 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br><p><font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：</p><ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"</li><li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li><li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li><li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”，”yyyy m d HH:MM:SS”，”yyyy/m/d HH:MM:SS”，”yyyy-m-d HH:MM:SS”，”yyyy.m.d HH:MM:SS”。</li><li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）<b>参数样例</b>： <code>"{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"</code><p><font color="red">ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时</font>，支持以下参数：</p><ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul><b>参数样例</b>：<code>"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"</code><p><font color="red">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：</p><ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li><li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul><b>参数样例</b>：<code>{"Rotate":-30,"RotateRelation":"Component_Id1"}</code><p><font color="red">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：</p><ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul><b>参数样例</b>：<code>{"Opacity":0.7}</code><p><font color="red">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：</p><ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul><b>参数样例</b>：<code>{"UseSealSize":true}</code><p><font color="red">签署意见功能设置，</font>当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：</p><ul><li> <b>Values</b>：签署意见预设的需要用户填写的文本</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li><li> <b>ValuesArray</b>：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）</li><li> <b>SignMethod</b>：签署方式，目前支持1-词组拼接方式</li></ul><b>参数样例</b>：<code>{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"],"SignMethod":1}</code><p><font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font></p><ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。<b>参数样例</b>：<code>"{"IgnoreKeywordError":1}"</code><p><font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时</font>，支持以下参数：</p><ul><li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li><b>参数样例</b>：<br><code>{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}</code><li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>ChildrenComponent结构体定义:<table border="1"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td></tr><tr> <td>ComponentValue</td> <td>string</td> <td>子控件值（签署方不可设置）</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table><b>参数样例</b>：<pre>{ "ChildrenComponents": [ { "ComponentType": "SIGN_SIGNATURE", "ComponentName": "个人签名", "Placeholder": "请签名", "ComponentOffsetX": 10, "ComponentOffsetY": 30, "ComponentWidth": 119, "ComponentHeight": 43, "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}" }, { "ComponentType": "SIGN_SELECTOR", "ComponentName": "是否同意此协议", "Placeholder": "", "ComponentOffsetX": 50, "ComponentOffsetY": 130, "ComponentWidth": 120, "ComponentHeight": 43, "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}" }, { "ComponentType": "SIGN_MULTI_LINE_TEXT", "ComponentName": "批注附言", "Placeholder": "", "ComponentOffsetX": 150, "ComponentOffsetY": 300, "ComponentWidth": 200, "ComponentHeight": 86, "ComponentExtra": "" } ]}</pre></ul>
|
|
12238
12250
|
:rtype: str
|
|
12239
12251
|
"""
|
|
12240
12252
|
return self._ComponentExtra
|
|
@@ -14039,7 +14051,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
|
|
|
14039
14051
|
:type AutoActive: bool
|
|
14040
14052
|
:param _BusinessLicense: <p>营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。<br>和BusinessLicenseId二选一即可</p>
|
|
14041
14053
|
:type BusinessLicense: str
|
|
14042
|
-
:param _ProxyAddress: <p>组织机构企业注册地址。
|
|
14054
|
+
:param _ProxyAddress: <p>组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。 </p><p>入参限制：最大长度500个字符</p>
|
|
14043
14055
|
:type ProxyAddress: str
|
|
14044
14056
|
:param _ProxyLegalName: <p>组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。</p>
|
|
14045
14057
|
:type ProxyLegalName: str
|
|
@@ -14262,7 +14274,7 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
|
|
|
14262
14274
|
|
|
14263
14275
|
@property
|
|
14264
14276
|
def ProxyAddress(self):
|
|
14265
|
-
r"""<p>组织机构企业注册地址。
|
|
14277
|
+
r"""<p>组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。 </p><p>入参限制：最大长度500个字符</p>
|
|
14266
14278
|
:rtype: str
|
|
14267
14279
|
"""
|
|
14268
14280
|
return self._ProxyAddress
|
|
@@ -15371,7 +15383,7 @@ class CreateFlowOption(AbstractModel):
|
|
|
15371
15383
|
:type SelfName: str
|
|
15372
15384
|
:param _HideSignCodeAfterStart: <p>发起后签署码隐藏，默认false，注：仅对新版页面生效</p>
|
|
15373
15385
|
:type HideSignCodeAfterStart: bool
|
|
15374
|
-
:param _NeedFlowDraft: <p
|
|
15386
|
+
:param _NeedFlowDraft: <p>发起过程中是否展示“保存草稿”按钮<br><img src="https://qcloudimg.tencent-cloud.cn/raw/9e863549f7f53c8bab2fa3c4b43c1715.png" alt="image"></p><ol><li>点击保存后，可以通过ChannelCreatePrepareFlow返回的DraftId保存草稿id</li><li>可以用于二次发起合同： <a href="https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/">ChannelCreatePrepareFlow</a>，ResourceType =3 //草稿</li></ol>
|
|
15375
15387
|
:type NeedFlowDraft: bool
|
|
15376
15388
|
:param _HideComponentTypes: <p>在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用（注:<br><font color="red">空数组代表未指定</font>），具体的控件类型如下</p><ul><li>SIGN_SIGNATURE : 个人签名/印章</li><li>SIGN_SEAL : 企业印章</li><li>SIGN_PAGING_SEAL : 骑缝章</li><li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li><li>SIGN_APPROVE : 签批</li><li>SIGN_OPINION : 签署意见</li><li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li><li>BUSI-FULL-NAME : 企业全称</li><li>BUSI-CREDIT-CODE : 统一社会信用代码</li><li>BUSI-LEGAL-NAME : 法人/经营者姓名</li><li>PERSONAL-NAME : 签署人姓名</li><li>PERSONAL-MOBILE : 签署人手机号</li><li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li><li>PERSONAL-IDCARD : 签署人证件号</li><li>TEXT : 单行文本</li><li>MULTI_LINE_TEXT : 多行文本</li><li>CHECK_BOX : 勾选框</li><li>SELECTOR : 选择器</li><li>DIGIT : 数字</li><li>DATE : 日期</li><li>FILL_IMAGE : 图片</li><li>ATTACHMENT : 附件</li><li>EMAIL : 邮箱</li><li>LOCATION : 地址</li><li>EDUCATION : 学历</li><li>GENDER : 性别</li><li>DISTRICT : 省市区</li></ul>
|
|
15377
15389
|
:type HideComponentTypes: list of str
|
|
@@ -15588,7 +15600,7 @@ class CreateFlowOption(AbstractModel):
|
|
|
15588
15600
|
|
|
15589
15601
|
@property
|
|
15590
15602
|
def NeedFlowDraft(self):
|
|
15591
|
-
r"""<p
|
|
15603
|
+
r"""<p>发起过程中是否展示“保存草稿”按钮<br><img src="https://qcloudimg.tencent-cloud.cn/raw/9e863549f7f53c8bab2fa3c4b43c1715.png" alt="image"></p><ol><li>点击保存后，可以通过ChannelCreatePrepareFlow返回的DraftId保存草稿id</li><li>可以用于二次发起合同： <a href="https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/">ChannelCreatePrepareFlow</a>，ResourceType =3 //草稿</li></ol>
|
|
15592
15604
|
:rtype: bool
|
|
15593
15605
|
"""
|
|
15594
15606
|
return self._NeedFlowDraft
|
|
@@ -19708,6 +19720,8 @@ class DescribeTemplatesRequest(AbstractModel):
|
|
|
19708
19720
|
:type QueryAllComponents: bool
|
|
19709
19721
|
:param _WithPreviewUrl: <p>是否获取模板预览链接。</p><ul><li>**false**：不获取（默认）</li><li>**true**：获取</li></ul><p>设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。</p>
|
|
19710
19722
|
:type WithPreviewUrl: bool
|
|
19723
|
+
:param _ShowPreviewComponents: <p>是否在模板预览页面展示模板控件。<br><br><ul><li><strong>false</strong>：不展示（默认），返回嵌入式预览链接，预览页面仅显示模板文件内容<br><img src="https://qcloudimg.tencent-cloud.cn/raw/7524b0fba5ad2b83a53ee9d7d486d233.png" alt="ShowTemplateControls=false"></li><li><strong>true</strong>：展示，返回嵌入式预览链接，预览页面在文件上叠加展示模板中的填写控件与签署控件，并增加模拟签署的特性。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/ff1b707408f9b3a7ef2e39b8ad659135.png" alt="ShowTemplateControls=true"></li></ul><br>注：仅在 <strong>WithPreviewUrl=true</strong> 时生效；当 <strong>WithPreviewUrl=false</strong> 时不生成预览链接，本参数被忽略。<br><br><strong>适用场景</strong>：当业务方需要在发起合同前预览模板中各角色的填写控件与签署控件的位置和布局，以便确认用户使用模板的控件配置是否正确时，可将此参数设置为 true。<br>示例值：false</p>
|
|
19724
|
+
:type ShowPreviewComponents: bool
|
|
19711
19725
|
:param _WithPdfUrl: <p>是否获取模板的PDF文件链接。</p><ul><li>**false**：不获取（默认）</li><li>**true**：获取</li></ul><p>设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地</p><p>注: <code>此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。</code></p>
|
|
19712
19726
|
:type WithPdfUrl: bool
|
|
19713
19727
|
:param _Operator: <p>操作者的信息</p>
|
|
@@ -19725,6 +19739,7 @@ class DescribeTemplatesRequest(AbstractModel):
|
|
|
19725
19739
|
self._ChannelTemplateId = None
|
|
19726
19740
|
self._QueryAllComponents = None
|
|
19727
19741
|
self._WithPreviewUrl = None
|
|
19742
|
+
self._ShowPreviewComponents = None
|
|
19728
19743
|
self._WithPdfUrl = None
|
|
19729
19744
|
self._Operator = None
|
|
19730
19745
|
self._UserFlowTypeId = None
|
|
@@ -19839,6 +19854,17 @@ class DescribeTemplatesRequest(AbstractModel):
|
|
|
19839
19854
|
def WithPreviewUrl(self, WithPreviewUrl):
|
|
19840
19855
|
self._WithPreviewUrl = WithPreviewUrl
|
|
19841
19856
|
|
|
19857
|
+
@property
|
|
19858
|
+
def ShowPreviewComponents(self):
|
|
19859
|
+
r"""<p>是否在模板预览页面展示模板控件。<br><br><ul><li><strong>false</strong>：不展示（默认），返回嵌入式预览链接，预览页面仅显示模板文件内容<br><img src="https://qcloudimg.tencent-cloud.cn/raw/7524b0fba5ad2b83a53ee9d7d486d233.png" alt="ShowTemplateControls=false"></li><li><strong>true</strong>：展示，返回嵌入式预览链接，预览页面在文件上叠加展示模板中的填写控件与签署控件，并增加模拟签署的特性。<br><img src="https://qcloudimg.tencent-cloud.cn/raw/ff1b707408f9b3a7ef2e39b8ad659135.png" alt="ShowTemplateControls=true"></li></ul><br>注：仅在 <strong>WithPreviewUrl=true</strong> 时生效；当 <strong>WithPreviewUrl=false</strong> 时不生成预览链接，本参数被忽略。<br><br><strong>适用场景</strong>：当业务方需要在发起合同前预览模板中各角色的填写控件与签署控件的位置和布局，以便确认用户使用模板的控件配置是否正确时，可将此参数设置为 true。<br>示例值：false</p>
|
|
19860
|
+
:rtype: bool
|
|
19861
|
+
"""
|
|
19862
|
+
return self._ShowPreviewComponents
|
|
19863
|
+
|
|
19864
|
+
@ShowPreviewComponents.setter
|
|
19865
|
+
def ShowPreviewComponents(self, ShowPreviewComponents):
|
|
19866
|
+
self._ShowPreviewComponents = ShowPreviewComponents
|
|
19867
|
+
|
|
19842
19868
|
@property
|
|
19843
19869
|
def WithPdfUrl(self):
|
|
19844
19870
|
r"""<p>是否获取模板的PDF文件链接。</p><ul><li>**false**：不获取（默认）</li><li>**true**：获取</li></ul><p>设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地</p><p>注: <code>此功能需要开通功能白名单【第三方应用集成企业获取模板PDF下载链接】，使用前请联系对接的客户经理沟通。</code></p>
|
|
@@ -19890,6 +19916,7 @@ class DescribeTemplatesRequest(AbstractModel):
|
|
|
19890
19916
|
self._ChannelTemplateId = params.get("ChannelTemplateId")
|
|
19891
19917
|
self._QueryAllComponents = params.get("QueryAllComponents")
|
|
19892
19918
|
self._WithPreviewUrl = params.get("WithPreviewUrl")
|
|
19919
|
+
self._ShowPreviewComponents = params.get("ShowPreviewComponents")
|
|
19893
19920
|
self._WithPdfUrl = params.get("WithPdfUrl")
|
|
19894
19921
|
if params.get("Operator") is not None:
|
|
19895
19922
|
self._Operator = UserInfo()
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: tencentcloud-sdk-python-essbasic
|
|
3
|
-
Version: 3.1.
|
|
3
|
+
Version: 3.1.174
|
|
4
4
|
Summary: Tencent Cloud Essbasic 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.
|
|
18
|
+
Requires-Dist: tencentcloud-sdk-python-common <4.0.0,>=3.1.174
|
|
19
19
|
|
|
20
20
|
============================
|
|
21
21
|
Tencent Cloud SDK for Python
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
tencentcloud/__init__.py,sha256=
|
|
1
|
+
tencentcloud/__init__.py,sha256=esw5mAtP-wSVUm7MlZoBUDjPFfrpvvFOh8YDeYbxFAU,630
|
|
2
2
|
tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
3
3
|
tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
4
|
tencentcloud/essbasic/v20201222/errorcodes.py,sha256=_HaXGynY1ocz-dbY7C6IOlNUWmNMu9XsY-x11g3Rm-w,5365
|
|
@@ -7,10 +7,10 @@ tencentcloud/essbasic/v20201222/essbasic_client_async.py,sha256=FDF4CJifYy6IfhH6
|
|
|
7
7
|
tencentcloud/essbasic/v20201222/models.py,sha256=P2ayL06cP1AmBPL9CbzFr9gO2naGrVFsa2RLHnN0QDc,335467
|
|
8
8
|
tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
9
9
|
tencentcloud/essbasic/v20210526/errorcodes.py,sha256=ipRcEnuaFrJJdvJvRMqmR_F8mAbqBp-ySUhVAmw4jvw,19938
|
|
10
|
-
tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=
|
|
11
|
-
tencentcloud/essbasic/v20210526/essbasic_client_async.py,sha256=
|
|
12
|
-
tencentcloud/essbasic/v20210526/models.py,sha256=
|
|
13
|
-
tencentcloud_sdk_python_essbasic-3.1.
|
|
14
|
-
tencentcloud_sdk_python_essbasic-3.1.
|
|
15
|
-
tencentcloud_sdk_python_essbasic-3.1.
|
|
16
|
-
tencentcloud_sdk_python_essbasic-3.1.
|
|
10
|
+
tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=G4nGUFB22Ms7ZVn8-t579PPy_REB_6il8SfM0BxZJOo,197919
|
|
11
|
+
tencentcloud/essbasic/v20210526/essbasic_client_async.py,sha256=_4NOPhzorCNYzMom2Cqs213oEEU9enpSSnTUmA8Pfjo,166305
|
|
12
|
+
tencentcloud/essbasic/v20210526/models.py,sha256=5QcZHvW7P0UmotoA01pZQxSrIbxMlebGYAEbiAGVqAY,1490093
|
|
13
|
+
tencentcloud_sdk_python_essbasic-3.1.174.dist-info/METADATA,sha256=LWYZ_oqkOUsr7G233s5-E34hWpXjHT3edF6yu02tNhw,1522
|
|
14
|
+
tencentcloud_sdk_python_essbasic-3.1.174.dist-info/WHEEL,sha256=a5ogxI61vGGBHYbAAwISCXsfU7mxKr76gTpCEmSNOI8,109
|
|
15
|
+
tencentcloud_sdk_python_essbasic-3.1.174.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
|
|
16
|
+
tencentcloud_sdk_python_essbasic-3.1.174.dist-info/RECORD,,
|
|
File without changes
|