tencentcloud-sdk-python-ess 3.0.983__tar.gz → 3.0.985__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.
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/PKG-INFO +1 -1
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/setup.py +1 -1
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud/__init__.py +1 -1
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud/ess/v20201111/ess_client.py +25 -21
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud/ess/v20201111/models.py +278 -171
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud_sdk_python_ess.egg-info/PKG-INFO +1 -1
- tencentcloud-sdk-python-ess-3.0.985/tencentcloud_sdk_python_ess.egg-info/requires.txt +1 -0
- tencentcloud-sdk-python-ess-3.0.983/tencentcloud_sdk_python_ess.egg-info/requires.txt +0 -1
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/README.rst +0 -0
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/setup.cfg +0 -0
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud/ess/__init__.py +0 -0
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud/ess/v20201111/__init__.py +0 -0
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud/ess/v20201111/errorcodes.py +0 -0
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud_sdk_python_ess.egg-info/SOURCES.txt +0 -0
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud_sdk_python_ess.egg-info/dependency_links.txt +0 -0
- {tencentcloud-sdk-python-ess-3.0.983 → tencentcloud-sdk-python-ess-3.0.985}/tencentcloud_sdk_python_ess.egg-info/top_level.txt +0 -0
|
@@ -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.0.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common==3.0.985"],
|
|
12
12
|
version=tencentcloud.__version__,
|
|
13
13
|
description='Tencent Cloud Ess SDK for Python',
|
|
14
14
|
long_description=open('README.rst').read(),
|
|
@@ -211,9 +211,11 @@ class EssClient(AbstractClient):
|
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
def CreateDocument(self, request):
|
|
214
|
-
"""
|
|
215
|
-
|
|
216
|
-
|
|
214
|
+
"""创建签署流程电子文档<br />
|
|
215
|
+
适用场景:见创建签署流程接口。<br />
|
|
216
|
+
点击查看<a href="https://qian.tencent.com/developers/startFlows/CreateFlow" target="_blank">通过模板创建签署流程</a>
|
|
217
|
+
<a href="https://qian.tencent.com/developers/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>。<br />
|
|
218
|
+
注:该接口需要给对应的流程指定一个模板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>接口使用。具体逻辑可以参考下图:
|
|
217
219
|
|
|
218
220
|
<svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
|
|
219
221
|
|
|
@@ -714,9 +716,9 @@ class EssClient(AbstractClient):
|
|
|
714
716
|
|
|
715
717
|
|
|
716
718
|
def CreatePrepareFlow(self, request):
|
|
717
|
-
"""
|
|
718
|
-
<br
|
|
719
|
-
<br
|
|
719
|
+
"""创建发起流程web页面
|
|
720
|
+
<br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
|
|
721
|
+
<br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
|
|
720
722
|
|
|
721
723
|
:param request: Request instance for CreatePrepareFlow.
|
|
722
724
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreatePrepareFlowRequest`
|
|
@@ -855,7 +857,7 @@ class EssClient(AbstractClient):
|
|
|
855
857
|
|
|
856
858
|
|
|
857
859
|
def CreateSealPolicy(self, request):
|
|
858
|
-
"""
|
|
860
|
+
"""本接口(CreateSealPolicy)用于对企业员工进行印章授权
|
|
859
861
|
|
|
860
862
|
:param request: Request instance for CreateSealPolicy.
|
|
861
863
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateSealPolicyRequest`
|
|
@@ -903,8 +905,9 @@ class EssClient(AbstractClient):
|
|
|
903
905
|
|
|
904
906
|
|
|
905
907
|
def CreateWebThemeConfig(self, request):
|
|
906
|
-
"""
|
|
907
|
-
|
|
908
|
+
"""用来设置本企业嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),设置后获取的web签署界面都会使用此配置进行展示。
|
|
909
|
+
|
|
910
|
+
如果多次调用,会以最后一次的配置为准
|
|
908
911
|
|
|
909
912
|
:param request: Request instance for CreateWebThemeConfig.
|
|
910
913
|
:type request: :class:`tencentcloud.ess.v20201111.models.CreateWebThemeConfigRequest`
|
|
@@ -1000,7 +1003,7 @@ class EssClient(AbstractClient):
|
|
|
1000
1003
|
|
|
1001
1004
|
|
|
1002
1005
|
def DeleteSealPolicies(self, request):
|
|
1003
|
-
"""
|
|
1006
|
+
"""本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限
|
|
1004
1007
|
|
|
1005
1008
|
:param request: Request instance for DeleteSealPolicies.
|
|
1006
1009
|
:type request: :class:`tencentcloud.ess.v20201111.models.DeleteSealPoliciesRequest`
|
|
@@ -1051,7 +1054,7 @@ class EssClient(AbstractClient):
|
|
|
1051
1054
|
|
|
1052
1055
|
|
|
1053
1056
|
def DescribeFileUrls(self, request):
|
|
1054
|
-
"""
|
|
1057
|
+
"""本接口(DescribeFileUrls)用于查询文件的下载URL。
|
|
1055
1058
|
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
1056
1059
|
|
|
1057
1060
|
:param request: Request instance for DescribeFileUrls.
|
|
@@ -1101,7 +1104,7 @@ class EssClient(AbstractClient):
|
|
|
1101
1104
|
|
|
1102
1105
|
|
|
1103
1106
|
def DescribeFlowComponents(self, request):
|
|
1104
|
-
"""
|
|
1107
|
+
"""查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
|
|
1105
1108
|
|
|
1106
1109
|
:param request: Request instance for DescribeFlowComponents.
|
|
1107
1110
|
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowComponentsRequest`
|
|
@@ -1155,7 +1158,8 @@ class EssClient(AbstractClient):
|
|
|
1155
1158
|
|
|
1156
1159
|
|
|
1157
1160
|
def DescribeFlowInfo(self, request):
|
|
1158
|
-
"""
|
|
1161
|
+
"""接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100)
|
|
1162
|
+
|
|
1159
1163
|
适用场景:可用于主动查询某个合同详情信息。
|
|
1160
1164
|
|
|
1161
1165
|
:param request: Request instance for DescribeFlowInfo.
|
|
@@ -1179,13 +1183,7 @@ class EssClient(AbstractClient):
|
|
|
1179
1183
|
|
|
1180
1184
|
|
|
1181
1185
|
def DescribeFlowTemplates(self, request):
|
|
1182
|
-
"""
|
|
1183
|
-
|
|
1184
|
-
当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
|
|
1185
|
-
|
|
1186
|
-
> **适用场景**
|
|
1187
|
-
>
|
|
1188
|
-
> 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
|
|
1186
|
+
"""此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。
|
|
1189
1187
|
> 一个模板通常会包含以下结构信息
|
|
1190
1188
|
>- 模板基本信息
|
|
1191
1189
|
>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
|
@@ -1193,6 +1191,12 @@ class EssClient(AbstractClient):
|
|
|
1193
1191
|
>- 签署控件 SignComponents
|
|
1194
1192
|
>- 生成模板的文件基础信息 FileInfos
|
|
1195
1193
|
|
|
1194
|
+
当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
|
|
1195
|
+
|
|
1196
|
+
适用场景:
|
|
1197
|
+
该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口,作为创建电子文档的前置接口使用。
|
|
1198
|
+
通过此接口查询到模板信息后,再通过调用创建电子文档接口,指定模板ID,指定模板中需要的填写控件内容等,完成电子文档的创建。
|
|
1199
|
+
|
|
1196
1200
|
:param request: Request instance for DescribeFlowTemplates.
|
|
1197
1201
|
:type request: :class:`tencentcloud.ess.v20201111.models.DescribeFlowTemplatesRequest`
|
|
1198
1202
|
:rtype: :class:`tencentcloud.ess.v20201111.models.DescribeFlowTemplatesResponse`
|
|
@@ -1626,7 +1630,7 @@ class EssClient(AbstractClient):
|
|
|
1626
1630
|
|
|
1627
1631
|
|
|
1628
1632
|
def VerifyPdf(self, request):
|
|
1629
|
-
"""
|
|
1633
|
+
"""对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
|
|
1630
1634
|
|
|
1631
1635
|
:param request: Request instance for VerifyPdf.
|
|
1632
1636
|
:type request: :class:`tencentcloud.ess.v20201111.models.VerifyPdfRequest`
|
|
@@ -2498,6 +2498,7 @@ class CreateDocumentRequest(AbstractModel):
|
|
|
2498
2498
|
:param _NeedPreview: 是否为预览模式,取值如下:
|
|
2499
2499
|
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
2500
2500
|
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
2501
|
+
注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
|
|
2501
2502
|
:type NeedPreview: bool
|
|
2502
2503
|
:param _PreviewType: 预览模式下产生的预览链接类型
|
|
2503
2504
|
<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
|
@@ -2637,7 +2638,8 @@ class CreateDocumentResponse(AbstractModel):
|
|
|
2637
2638
|
:type DocumentId: str
|
|
2638
2639
|
:param _PreviewFileUrl: 合同预览链接URL。
|
|
2639
2640
|
|
|
2640
|
-
|
|
2641
|
+
注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
|
|
2642
|
+
`2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
|
|
2641
2643
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2642
2644
|
:type PreviewFileUrl: str
|
|
2643
2645
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3805,46 +3807,46 @@ class CreateFlowOption(AbstractModel):
|
|
|
3805
3807
|
def __init__(self):
|
|
3806
3808
|
r"""
|
|
3807
3809
|
:param _CanEditFlow: 是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。
|
|
3808
|
-
<br/>true
|
|
3810
|
+
<br/>true:允许编辑<br/>false:不允许编辑(默认值)<br/>
|
|
3809
3811
|
:type CanEditFlow: bool
|
|
3810
3812
|
:param _CanEditFormField: 是否允许编辑模板控件
|
|
3811
3813
|
<br/>true:允许编辑模板控件信息
|
|
3812
|
-
<br/>false
|
|
3813
|
-
<br
|
|
3814
|
+
<br/>false:不允许编辑模板控件信息(默认值)
|
|
3815
|
+
<br/>
|
|
3814
3816
|
:type CanEditFormField: bool
|
|
3815
3817
|
:param _HideShowFlowName: 发起页面隐藏合同名称展示
|
|
3816
3818
|
<br/>true:发起页面隐藏合同名称展示
|
|
3817
|
-
<br/>false
|
|
3818
|
-
<br
|
|
3819
|
+
<br/>false:发起页面不隐藏合同名称展示(默认值)
|
|
3820
|
+
<br/>
|
|
3819
3821
|
:type HideShowFlowName: bool
|
|
3820
3822
|
:param _HideShowFlowType: 发起页面隐藏合同类型展示
|
|
3821
3823
|
<br/>true:发起页面隐藏合同类型展示
|
|
3822
|
-
<br/>false
|
|
3823
|
-
<br
|
|
3824
|
+
<br/>false:发起页面不隐藏合同类型展示(默认值)
|
|
3825
|
+
<br/>
|
|
3824
3826
|
|
|
3825
3827
|
:type HideShowFlowType: bool
|
|
3826
3828
|
:param _HideShowDeadline: 发起页面隐藏合同截止日期展示
|
|
3827
3829
|
<br/>true:发起页面隐藏合同截止日期展示
|
|
3828
|
-
<br/>false
|
|
3829
|
-
<br
|
|
3830
|
+
<br/>false:发起页面不隐藏合同截止日期展示(默认值)
|
|
3831
|
+
<br/>
|
|
3830
3832
|
:type HideShowDeadline: bool
|
|
3831
3833
|
:param _CanSkipAddApprover: 发起页面允许跳过添加签署人环节
|
|
3832
3834
|
<br/>true:发起页面允许跳过添加签署人环节
|
|
3833
|
-
<br/>false
|
|
3834
|
-
<br
|
|
3835
|
+
<br/>false:发起页面不允许跳过添加签署人环节(默认值)
|
|
3836
|
+
<br/>
|
|
3835
3837
|
|
|
3836
3838
|
:type CanSkipAddApprover: bool
|
|
3837
3839
|
:param _SkipUploadFile: 文件发起页面跳过文件上传步骤
|
|
3838
3840
|
<br/>true:文件发起页面跳过文件上传步骤
|
|
3839
|
-
<br/>false
|
|
3840
|
-
<br
|
|
3841
|
+
<br/>false:文件发起页面不跳过文件上传步骤(默认值)
|
|
3842
|
+
<br/>
|
|
3841
3843
|
:type SkipUploadFile: bool
|
|
3842
3844
|
:param _ForbidEditFillComponent: 禁止编辑填写控件
|
|
3843
3845
|
<br/>true:禁止编辑填写控件
|
|
3844
|
-
<br/>false
|
|
3845
|
-
<br
|
|
3846
|
+
<br/>false:允许编辑填写控件(默认值)
|
|
3847
|
+
<br/>
|
|
3846
3848
|
:type ForbidEditFillComponent: bool
|
|
3847
|
-
:param _CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500
|
|
3849
|
+
:param _CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500字符
|
|
3848
3850
|
|
|
3849
3851
|
:type CustomCreateFlowDescription: str
|
|
3850
3852
|
"""
|
|
@@ -5817,63 +5819,79 @@ class CreatePrepareFlowRequest(AbstractModel):
|
|
|
5817
5819
|
|
|
5818
5820
|
def __init__(self):
|
|
5819
5821
|
r"""
|
|
5820
|
-
:param _Operator:
|
|
5822
|
+
:param _Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
5823
|
+
支持填入集团子公司经办人 userId 代发合同。
|
|
5824
|
+
|
|
5825
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
5821
5826
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
5822
|
-
:param _ResourceId: 资源id,与ResourceType
|
|
5827
|
+
:param _ResourceId: 资源id,与ResourceType相对应,取值范围:
|
|
5828
|
+
<ul>
|
|
5829
|
+
<li>文件Id(通过UploadFiles获取文件资源Id)</li>
|
|
5830
|
+
<li>模板Id</li>
|
|
5831
|
+
</ul>
|
|
5823
5832
|
:type ResourceId: str
|
|
5824
|
-
:param _FlowName:
|
|
5833
|
+
:param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
5834
|
+
|
|
5825
5835
|
:type FlowName: str
|
|
5826
|
-
:param _Unordered:
|
|
5827
|
-
|
|
5828
|
-
|
|
5836
|
+
:param _Unordered: 合同流程的签署顺序类型:
|
|
5837
|
+
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
5838
|
+
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
5829
5839
|
:type Unordered: bool
|
|
5830
|
-
:param _Deadline:
|
|
5831
|
-
|
|
5832
|
-
不传默认为当前时间一年后
|
|
5840
|
+
:param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
|
5841
|
+
|
|
5833
5842
|
:type Deadline: int
|
|
5834
5843
|
:param _UserFlowTypeId: 用户自定义合同类型Id
|
|
5835
5844
|
|
|
5836
|
-
该id为电子签企业内的合同类型id,
|
|
5845
|
+
该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
|
|
5846
|
+
注: `该参数如果和FlowType同时传,以该参数优先生效`
|
|
5837
5847
|
:type UserFlowTypeId: str
|
|
5838
|
-
:param _FlowType:
|
|
5839
|
-
该字段用于客户自定义合同类型
|
|
5840
|
-
建议使用时指定合同类型,便于之后合同分类以及查看
|
|
5841
|
-
如果合同类型与自定义的合同类型描述一致,会自动归类到自定义的合同类型处,如果不一致,则会创建一个新的自定义合同类型
|
|
5848
|
+
:param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
|
5842
5849
|
:type FlowType: str
|
|
5843
|
-
:param _Approvers:
|
|
5850
|
+
:param _Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
|
5851
|
+
|
|
5852
|
+
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
|
5844
5853
|
:type Approvers: list of FlowCreateApprover
|
|
5845
|
-
:param _IntelligentStatus:
|
|
5846
|
-
|
|
5847
|
-
|
|
5854
|
+
:param _IntelligentStatus: 开启或者关闭智能添加填写区:
|
|
5855
|
+
<ul><li> **OPEN**:开启(默认值)</li>
|
|
5856
|
+
<li> **CLOSE**:关闭</li></ul>
|
|
5848
5857
|
:type IntelligentStatus: str
|
|
5849
|
-
:param _ResourceType:
|
|
5850
|
-
1
|
|
5851
|
-
2
|
|
5852
|
-
不传默认为2:文件
|
|
5858
|
+
:param _ResourceType: 资源类型,取值有:
|
|
5859
|
+
<ul><li> **1**:模板</li>
|
|
5860
|
+
<li> **2**:文件(默认值)</li></ul>
|
|
5853
5861
|
:type ResourceType: int
|
|
5854
|
-
:param _Components:
|
|
5855
|
-
该类型控件由发起方完成填写
|
|
5862
|
+
:param _Components: 该字段已废弃,请使用InitiatorComponents
|
|
5856
5863
|
:type Components: :class:`tencentcloud.ess.v20201111.models.Component`
|
|
5857
5864
|
:param _FlowOption: 发起合同个性化参数
|
|
5858
5865
|
用于满足创建及页面操作过程中的个性化要求
|
|
5859
5866
|
具体定制化内容详见数据接口说明
|
|
5860
5867
|
:type FlowOption: :class:`tencentcloud.ess.v20201111.models.CreateFlowOption`
|
|
5861
|
-
:param _NeedSignReview:
|
|
5862
|
-
|
|
5863
|
-
|
|
5864
|
-
|
|
5868
|
+
:param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
5869
|
+
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
5870
|
+
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
5871
|
+
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
5872
|
+
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
5873
|
+
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
5874
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
5865
5875
|
:type NeedSignReview: bool
|
|
5866
|
-
:param _NeedCreateReview:
|
|
5867
|
-
|
|
5868
|
-
|
|
5869
|
-
|
|
5876
|
+
:param _NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
5877
|
+
|
|
5878
|
+
若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
|
|
5879
|
+
|
|
5880
|
+
|
|
5870
5881
|
:type NeedCreateReview: bool
|
|
5871
|
-
:param _UserData:
|
|
5882
|
+
:param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
5883
|
+
|
|
5884
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
5872
5885
|
:type UserData: str
|
|
5873
|
-
:param _FlowId: 合同
|
|
5886
|
+
:param _FlowId: 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
|
|
5887
|
+
注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
|
|
5874
5888
|
:type FlowId: str
|
|
5875
|
-
:param _Agent:
|
|
5889
|
+
:param _Agent: 代理企业和员工的信息。
|
|
5890
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
5876
5891
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
5892
|
+
:param _InitiatorComponents: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
5893
|
+
|
|
5894
|
+
:type InitiatorComponents: list of Component
|
|
5877
5895
|
"""
|
|
5878
5896
|
self._Operator = None
|
|
5879
5897
|
self._ResourceId = None
|
|
@@ -5892,6 +5910,7 @@ false:不开启发起方发起合同审核
|
|
|
5892
5910
|
self._UserData = None
|
|
5893
5911
|
self._FlowId = None
|
|
5894
5912
|
self._Agent = None
|
|
5913
|
+
self._InitiatorComponents = None
|
|
5895
5914
|
|
|
5896
5915
|
@property
|
|
5897
5916
|
def Operator(self):
|
|
@@ -6029,6 +6048,14 @@ false:不开启发起方发起合同审核
|
|
|
6029
6048
|
def Agent(self, Agent):
|
|
6030
6049
|
self._Agent = Agent
|
|
6031
6050
|
|
|
6051
|
+
@property
|
|
6052
|
+
def InitiatorComponents(self):
|
|
6053
|
+
return self._InitiatorComponents
|
|
6054
|
+
|
|
6055
|
+
@InitiatorComponents.setter
|
|
6056
|
+
def InitiatorComponents(self, InitiatorComponents):
|
|
6057
|
+
self._InitiatorComponents = InitiatorComponents
|
|
6058
|
+
|
|
6032
6059
|
|
|
6033
6060
|
def _deserialize(self, params):
|
|
6034
6061
|
if params.get("Operator") is not None:
|
|
@@ -6061,6 +6088,12 @@ false:不开启发起方发起合同审核
|
|
|
6061
6088
|
if params.get("Agent") is not None:
|
|
6062
6089
|
self._Agent = Agent()
|
|
6063
6090
|
self._Agent._deserialize(params.get("Agent"))
|
|
6091
|
+
if params.get("InitiatorComponents") is not None:
|
|
6092
|
+
self._InitiatorComponents = []
|
|
6093
|
+
for item in params.get("InitiatorComponents"):
|
|
6094
|
+
obj = Component()
|
|
6095
|
+
obj._deserialize(item)
|
|
6096
|
+
self._InitiatorComponents.append(obj)
|
|
6064
6097
|
memeber_set = set(params.keys())
|
|
6065
6098
|
for name, value in vars(self).items():
|
|
6066
6099
|
property_name = name[1:]
|
|
@@ -6078,7 +6111,7 @@ class CreatePrepareFlowResponse(AbstractModel):
|
|
|
6078
6111
|
|
|
6079
6112
|
def __init__(self):
|
|
6080
6113
|
r"""
|
|
6081
|
-
:param _Url:
|
|
6114
|
+
:param _Url: 发起流程的web页面链接,有效期5分钟
|
|
6082
6115
|
:type Url: str
|
|
6083
6116
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6084
6117
|
:type RequestId: str
|
|
@@ -6117,18 +6150,20 @@ class CreatePreparedPersonalEsignRequest(AbstractModel):
|
|
|
6117
6150
|
r"""
|
|
6118
6151
|
:param _UserName: 个人用户姓名
|
|
6119
6152
|
:type UserName: str
|
|
6120
|
-
:param _IdCardNumber:
|
|
6153
|
+
:param _IdCardNumber: 证件号码,应符合以下规则
|
|
6154
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
6155
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
6156
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
6121
6157
|
:type IdCardNumber: str
|
|
6122
|
-
:param _SealName:
|
|
6158
|
+
:param _SealName: 印章名称,长度1-50个字。
|
|
6123
6159
|
:type SealName: str
|
|
6124
|
-
:param _Operator:
|
|
6160
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
6161
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
6125
6162
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
6126
|
-
:param _IdCardType:
|
|
6127
|
-
ID_CARD
|
|
6128
|
-
|
|
6129
|
-
|
|
6130
|
-
FOREIGN_ID_CARD 境外身份
|
|
6131
|
-
HONGKONG_MACAO_AND_TAIWAN 中国台湾
|
|
6163
|
+
:param _IdCardType: 证件类型,支持以下类型
|
|
6164
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
6165
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
6166
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
6132
6167
|
:type IdCardType: str
|
|
6133
6168
|
:param _SealImage: 印章图片的base64
|
|
6134
6169
|
注:已废弃
|
|
@@ -6147,16 +6182,19 @@ BLACK 黑色,
|
|
|
6147
6182
|
RED 红色,
|
|
6148
6183
|
BLUE 蓝色。
|
|
6149
6184
|
:type SealColor: str
|
|
6150
|
-
:param _ProcessSeal:
|
|
6151
|
-
|
|
6152
|
-
|
|
6153
|
-
|
|
6185
|
+
:param _ProcessSeal: 是否处理印章,默认不做印章处理。
|
|
6186
|
+
取值如下:
|
|
6187
|
+
<ul>
|
|
6188
|
+
<li>false:不做任何处理;</li>
|
|
6189
|
+
<li>true:做透明化处理和颜色增强。</li>
|
|
6190
|
+
</ul>
|
|
6154
6191
|
:type ProcessSeal: bool
|
|
6155
6192
|
:param _FileId: 印章图片文件 id
|
|
6156
6193
|
取值:
|
|
6157
6194
|
填写的FileId通过UploadFiles接口上传文件获取。
|
|
6158
6195
|
:type FileId: str
|
|
6159
|
-
:param _Agent:
|
|
6196
|
+
:param _Agent: 代理企业和员工的信息。
|
|
6197
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
6160
6198
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
6161
6199
|
:param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减
|
|
6162
6200
|
:type LicenseType: int
|
|
@@ -6329,7 +6367,8 @@ class CreatePreparedPersonalEsignResponse(AbstractModel):
|
|
|
6329
6367
|
|
|
6330
6368
|
def __init__(self):
|
|
6331
6369
|
r"""
|
|
6332
|
-
:param _SealId: 导入生成的印章ID
|
|
6370
|
+
:param _SealId: 导入生成的印章ID,为32位字符串。
|
|
6371
|
+
建议开发者保存此印章ID,开头实名认证后,通过此 ID查询导入的印章。
|
|
6333
6372
|
:type SealId: str
|
|
6334
6373
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6335
6374
|
:type RequestId: str
|
|
@@ -6752,11 +6791,14 @@ class CreateSealPolicyRequest(AbstractModel):
|
|
|
6752
6791
|
|
|
6753
6792
|
def __init__(self):
|
|
6754
6793
|
r"""
|
|
6755
|
-
:param _Operator:
|
|
6794
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
6795
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
6756
6796
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
6757
6797
|
:param _Users: 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用
|
|
6758
6798
|
:type Users: list of UserInfo
|
|
6759
|
-
:param _SealId:
|
|
6799
|
+
:param _SealId: 电子印章ID,为32位字符串。
|
|
6800
|
+
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
6801
|
+
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
6760
6802
|
:type SealId: str
|
|
6761
6803
|
:param _Expired: 授权有效期。时间戳秒级
|
|
6762
6804
|
:type Expired: int
|
|
@@ -6764,7 +6806,8 @@ class CreateSealPolicyRequest(AbstractModel):
|
|
|
6764
6806
|
:type UserIds: list of str
|
|
6765
6807
|
:param _Policy: 印章授权内容
|
|
6766
6808
|
:type Policy: str
|
|
6767
|
-
:param _Agent:
|
|
6809
|
+
:param _Agent: 代理企业和员工的信息。
|
|
6810
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
6768
6811
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
6769
6812
|
"""
|
|
6770
6813
|
self._Operator = None
|
|
@@ -6866,7 +6909,8 @@ class CreateSealPolicyResponse(AbstractModel):
|
|
|
6866
6909
|
|
|
6867
6910
|
def __init__(self):
|
|
6868
6911
|
r"""
|
|
6869
|
-
:param _UserIds:
|
|
6912
|
+
:param _UserIds: 最终授权成功的用户ID,在腾讯电子签平台的唯一身份标识,为32位字符串。
|
|
6913
|
+
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
6870
6914
|
:type UserIds: list of str
|
|
6871
6915
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6872
6916
|
:type RequestId: str
|
|
@@ -6916,10 +6960,12 @@ class CreateSealRequest(AbstractModel):
|
|
|
6916
6960
|
如果要使用图片上传请传字段 Image
|
|
6917
6961
|
:type GenerateSource: str
|
|
6918
6962
|
:param _SealType: 电子印章类型:
|
|
6919
|
-
|
|
6920
|
-
|
|
6921
|
-
|
|
6922
|
-
|
|
6963
|
+
<ul>
|
|
6964
|
+
<li>OFFICIAL-公章;</li>
|
|
6965
|
+
<li>CONTRACT-合同专用章;</li>
|
|
6966
|
+
<li>FINANCE-合财务专用章;</li>
|
|
6967
|
+
<li>PERSONNEL-人事专用章.</li>
|
|
6968
|
+
</ul>
|
|
6923
6969
|
:type SealType: str
|
|
6924
6970
|
:param _FileName: 电子印章图片文件名称,1-50个中文字符。
|
|
6925
6971
|
:type FileName: str
|
|
@@ -6945,16 +6991,20 @@ PERSONNEL-人事专用章.
|
|
|
6945
6991
|
:param _FileToken: 通过文件上传时,服务端生成的电子印章上传图片的token
|
|
6946
6992
|
|
|
6947
6993
|
:type FileToken: str
|
|
6948
|
-
:param _SealStyle:
|
|
6994
|
+
:param _SealStyle: 印章样式,取值如下:
|
|
6949
6995
|
|
|
6950
|
-
|
|
6951
|
-
|
|
6952
|
-
|
|
6996
|
+
<ul>
|
|
6997
|
+
<li>cycle:圆形印章;</li>
|
|
6998
|
+
<li>ellipse:椭圆印章;</li>
|
|
6999
|
+
<li>注:默认圆形印章</li>
|
|
7000
|
+
</ul>
|
|
6953
7001
|
:type SealStyle: str
|
|
6954
7002
|
:param _SealSize: 印章尺寸取值描述:
|
|
6955
|
-
|
|
6956
|
-
|
|
6957
|
-
|
|
7003
|
+
<ul>
|
|
7004
|
+
<li>42_42 圆形企业公章直径42mm;</li>
|
|
7005
|
+
<li>40_40 圆形企业印章直径40mm;</li>
|
|
7006
|
+
<li>45_30 椭圆形印章45mm x 30mm;</li>
|
|
7007
|
+
</ul>
|
|
6958
7008
|
:type SealSize: str
|
|
6959
7009
|
"""
|
|
6960
7010
|
self._Operator = None
|
|
@@ -7141,7 +7191,9 @@ class CreateSealResponse(AbstractModel):
|
|
|
7141
7191
|
|
|
7142
7192
|
def __init__(self):
|
|
7143
7193
|
r"""
|
|
7144
|
-
:param _SealId:
|
|
7194
|
+
:param _SealId: 电子印章ID,为32位字符串。
|
|
7195
|
+
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
7196
|
+
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
7145
7197
|
:type SealId: str
|
|
7146
7198
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
7147
7199
|
:type RequestId: str
|
|
@@ -7480,7 +7532,7 @@ class CreateWebThemeConfigRequest(AbstractModel):
|
|
|
7480
7532
|
<ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
|
|
7481
7533
|
</ul>
|
|
7482
7534
|
:type ThemeType: str
|
|
7483
|
-
:param _WebThemeConfig:
|
|
7535
|
+
:param _WebThemeConfig: 电子签logo是否展示,主体颜色等配置项
|
|
7484
7536
|
:type WebThemeConfig: :class:`tencentcloud.ess.v20201111.models.WebThemeConfig`
|
|
7485
7537
|
:param _Agent: 代理企业和员工的信息。
|
|
7486
7538
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
@@ -7904,15 +7956,21 @@ class DeleteSealPoliciesRequest(AbstractModel):
|
|
|
7904
7956
|
|
|
7905
7957
|
def __init__(self):
|
|
7906
7958
|
r"""
|
|
7907
|
-
:param _Operator:
|
|
7959
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
7960
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
7908
7961
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
7909
7962
|
:param _PolicyIds: 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
|
|
7910
7963
|
:type PolicyIds: list of str
|
|
7911
|
-
:param _SealId:
|
|
7964
|
+
:param _SealId: 电子印章ID,为32位字符串。
|
|
7965
|
+
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
7966
|
+
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
7967
|
+
注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
|
|
7912
7968
|
:type SealId: str
|
|
7913
|
-
:param _UserIds: 待授权的员工ID
|
|
7969
|
+
:param _UserIds: 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
|
7970
|
+
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
7914
7971
|
:type UserIds: list of str
|
|
7915
|
-
:param _Agent:
|
|
7972
|
+
:param _Agent: 代理企业和员工的信息。
|
|
7973
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
7916
7974
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
7917
7975
|
"""
|
|
7918
7976
|
self._Operator = None
|
|
@@ -8228,24 +8286,38 @@ class DescribeFileUrlsRequest(AbstractModel):
|
|
|
8228
8286
|
|
|
8229
8287
|
def __init__(self):
|
|
8230
8288
|
r"""
|
|
8231
|
-
:param _Operator:
|
|
8289
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
8290
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
8232
8291
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
8233
8292
|
:param _BusinessType: 文件对应的业务类型,目前支持:
|
|
8234
|
-
|
|
8235
|
-
|
|
8236
|
-
|
|
8237
|
-
|
|
8293
|
+
<ul>
|
|
8294
|
+
<li>FLOW 如需下载合同文件请选择此项</li>
|
|
8295
|
+
<li>TEMPLATE 如需下载模板文件请选择此项</li>
|
|
8296
|
+
<li>DOCUMENT 如需下载文档文件请选择此项</li>
|
|
8297
|
+
<li>SEAL 如需下载印章图片请选择此项</li>
|
|
8298
|
+
</ul>
|
|
8238
8299
|
:type BusinessType: str
|
|
8239
|
-
:param _BusinessIds:
|
|
8240
|
-
|
|
8300
|
+
:param _BusinessIds: 业务编号的数组,取值如下:
|
|
8301
|
+
<ul>
|
|
8302
|
+
<li>流程编号</li>
|
|
8303
|
+
<li>模板编号</li>
|
|
8304
|
+
<li>文档编号</li>
|
|
8305
|
+
<li>印章编号</li>
|
|
8306
|
+
<li>如需下载合同文件请传入FlowId,最大支持20个资源</li>
|
|
8307
|
+
</ul>
|
|
8241
8308
|
:type BusinessIds: list of str
|
|
8242
8309
|
:param _FileName: 下载后的文件命名,只有FileType为zip的时候生效
|
|
8243
8310
|
:type FileName: str
|
|
8244
|
-
:param _FileType:
|
|
8311
|
+
:param _FileType: 要下载的文件类型,取值如下:
|
|
8312
|
+
<ul>
|
|
8313
|
+
<li>JPG</li>
|
|
8314
|
+
<li>PDF</li>
|
|
8315
|
+
<li>ZIP</li>
|
|
8316
|
+
</ul>
|
|
8245
8317
|
:type FileType: str
|
|
8246
|
-
:param _Offset:
|
|
8318
|
+
:param _Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。
|
|
8247
8319
|
:type Offset: int
|
|
8248
|
-
:param _Limit:
|
|
8320
|
+
:param _Limit: 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。
|
|
8249
8321
|
:type Limit: int
|
|
8250
8322
|
:param _UrlTtl: 下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)
|
|
8251
8323
|
:type UrlTtl: int
|
|
@@ -8563,11 +8635,15 @@ class DescribeFlowComponentsRequest(AbstractModel):
|
|
|
8563
8635
|
|
|
8564
8636
|
def __init__(self):
|
|
8565
8637
|
r"""
|
|
8566
|
-
:param _Operator:
|
|
8638
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
8639
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
8567
8640
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
8568
|
-
:param _FlowId:
|
|
8641
|
+
:param _FlowId: 合同流程ID,为32位字符串。
|
|
8642
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
8643
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
8569
8644
|
:type FlowId: str
|
|
8570
|
-
:param _Agent:
|
|
8645
|
+
:param _Agent: 代理企业和员工的信息。
|
|
8646
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
8571
8647
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
8572
8648
|
"""
|
|
8573
8649
|
self._Operator = None
|
|
@@ -8624,7 +8700,7 @@ class DescribeFlowComponentsResponse(AbstractModel):
|
|
|
8624
8700
|
|
|
8625
8701
|
def __init__(self):
|
|
8626
8702
|
r"""
|
|
8627
|
-
:param _RecipientComponentInfos:
|
|
8703
|
+
:param _RecipientComponentInfos: 合同流程关联的填写控件信息,按照参与方进行分类返回。
|
|
8628
8704
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
8629
8705
|
:type RecipientComponentInfos: list of RecipientComponentInfo
|
|
8630
8706
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -8784,13 +8860,13 @@ class DescribeFlowInfoRequest(AbstractModel):
|
|
|
8784
8860
|
|
|
8785
8861
|
def __init__(self):
|
|
8786
8862
|
r"""
|
|
8787
|
-
:param _Operator:
|
|
8863
|
+
:param _Operator: 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
8788
8864
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
8789
8865
|
:param _FlowIds: 需要查询的流程ID列表,限制最大100个
|
|
8790
8866
|
|
|
8791
8867
|
如果查询合同组的信息,不要传此参数
|
|
8792
8868
|
:type FlowIds: list of str
|
|
8793
|
-
:param _Agent:
|
|
8869
|
+
:param _Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
8794
8870
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
8795
8871
|
:param _FlowGroupId: 合同组ID, 如果传此参数会忽略FlowIds入参
|
|
8796
8872
|
所以如传此参数不要传FlowIds参数
|
|
@@ -8863,7 +8939,7 @@ class DescribeFlowInfoResponse(AbstractModel):
|
|
|
8863
8939
|
r"""
|
|
8864
8940
|
:param _FlowDetailInfos: 签署流程信息
|
|
8865
8941
|
:type FlowDetailInfos: list of FlowDetailInfo
|
|
8866
|
-
:param _FlowGroupId: 合同组ID
|
|
8942
|
+
:param _FlowGroupId: 合同组ID,为32位字符串
|
|
8867
8943
|
:type FlowGroupId: str
|
|
8868
8944
|
:param _FlowGroupName: 合同组名称
|
|
8869
8945
|
:type FlowGroupName: str
|
|
@@ -8927,28 +9003,32 @@ class DescribeFlowTemplatesRequest(AbstractModel):
|
|
|
8927
9003
|
|
|
8928
9004
|
def __init__(self):
|
|
8929
9005
|
r"""
|
|
8930
|
-
:param _Operator:
|
|
8931
|
-
|
|
8932
|
-
注:请保证员工有相关的角色权限
|
|
9006
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
9007
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
8933
9008
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
8934
|
-
:param _Agent:
|
|
8935
|
-
|
|
9009
|
+
:param _Agent: 代理企业和员工的信息。
|
|
9010
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
8936
9011
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
8937
|
-
:param _ContentType:
|
|
8938
|
-
|
|
8939
|
-
|
|
9012
|
+
:param _ContentType: 查询内容控制
|
|
9013
|
+
|
|
9014
|
+
<ul><li>**0**:模板列表及详情(默认)</li>
|
|
9015
|
+
<li>**1**:仅模板列表</li></ul>
|
|
8940
9016
|
:type ContentType: int
|
|
8941
9017
|
:param _Filters: 搜索条件,本字段用于指定模板Id进行查询。
|
|
8942
|
-
Key:template-id
|
|
8943
|
-
Values:需要查询的模板Id列表
|
|
9018
|
+
Key:template-id Values:需要查询的模板Id列表
|
|
8944
9019
|
:type Filters: list of Filter
|
|
8945
|
-
:param _Offset:
|
|
9020
|
+
:param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
|
|
9021
|
+
|
|
9022
|
+
注:`1.offset从0开始,即第一页为0。`
|
|
9023
|
+
`2.默认从第一页返回。`
|
|
8946
9024
|
:type Offset: int
|
|
8947
|
-
:param _Limit:
|
|
9025
|
+
:param _Limit: 指定每页返回的数据条数,和Offset参数配合使用。
|
|
9026
|
+
|
|
9027
|
+
注:`1.默认值为20,单页做大值为200。`
|
|
8948
9028
|
:type Limit: int
|
|
8949
|
-
:param _ApplicationId:
|
|
8950
|
-
|
|
8951
|
-
ApplicationId
|
|
9029
|
+
:param _ApplicationId: 指定查询的应用号,指定后查询该应用号下的模板列表。
|
|
9030
|
+
|
|
9031
|
+
注:`1.ApplicationId为空时,查询所有应用下的模板列表。`
|
|
8952
9032
|
:type ApplicationId: str
|
|
8953
9033
|
:param _IsChannel: 默认为false,查询SaaS模板库列表;
|
|
8954
9034
|
为true,查询第三方应用集成平台企业模板库管理列表
|
|
@@ -9101,9 +9181,9 @@ class DescribeFlowTemplatesResponse(AbstractModel):
|
|
|
9101
9181
|
|
|
9102
9182
|
def __init__(self):
|
|
9103
9183
|
r"""
|
|
9104
|
-
:param _Templates:
|
|
9184
|
+
:param _Templates: 模板详情列表数据
|
|
9105
9185
|
:type Templates: list of TemplateInfo
|
|
9106
|
-
:param _TotalCount:
|
|
9186
|
+
:param _TotalCount: 查询到的模板总数
|
|
9107
9187
|
:type TotalCount: int
|
|
9108
9188
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
9109
9189
|
:type RequestId: str
|
|
@@ -9877,37 +9957,46 @@ class DescribeOrganizationSealsRequest(AbstractModel):
|
|
|
9877
9957
|
|
|
9878
9958
|
def __init__(self):
|
|
9879
9959
|
r"""
|
|
9880
|
-
:param _Operator:
|
|
9960
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
9961
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
9881
9962
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
9882
|
-
:param _Limit:
|
|
9963
|
+
:param _Limit: 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。
|
|
9883
9964
|
:type Limit: int
|
|
9884
|
-
:param _Offset:
|
|
9965
|
+
:param _Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000。
|
|
9885
9966
|
:type Offset: int
|
|
9886
|
-
:param _InfoType:
|
|
9967
|
+
:param _InfoType: 查询信息类型,取值如下:
|
|
9968
|
+
<ul>
|
|
9969
|
+
<li>0不返回授权用户</li>
|
|
9970
|
+
<li>1返回授权用户信息</li>
|
|
9971
|
+
</ul>
|
|
9887
9972
|
:type InfoType: int
|
|
9888
9973
|
:param _SealId: 印章id(没有输入返回所有)
|
|
9889
9974
|
:type SealId: str
|
|
9890
9975
|
:param _SealTypes: 印章类型列表(都是组织机构印章)。
|
|
9891
9976
|
为空时查询所有类型的印章。
|
|
9892
9977
|
目前支持以下类型:
|
|
9893
|
-
|
|
9894
|
-
|
|
9895
|
-
|
|
9896
|
-
|
|
9978
|
+
<ul>
|
|
9979
|
+
<li>OFFICIAL:企业公章;</li>
|
|
9980
|
+
<li>CONTRACT:合同专用章;</li>
|
|
9981
|
+
<li>ORGANIZATION_SEAL:企业印章(图片上传创建);</li>
|
|
9982
|
+
<li>LEGAL_PERSON_SEAL:法定代表人章</li>
|
|
9983
|
+
</ul>
|
|
9897
9984
|
:type SealTypes: list of str
|
|
9898
|
-
:param _Agent:
|
|
9985
|
+
:param _Agent: 代理企业和员工的信息。
|
|
9986
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
9899
9987
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
9900
9988
|
:param _SealStatuses: 查询的印章状态列表。
|
|
9901
|
-
|
|
9902
|
-
|
|
9903
|
-
|
|
9904
|
-
|
|
9905
|
-
|
|
9906
|
-
|
|
9907
|
-
|
|
9908
|
-
|
|
9909
|
-
|
|
9910
|
-
|
|
9989
|
+
<ul>
|
|
9990
|
+
<li>空,只查询启用状态的印章;</li>
|
|
9991
|
+
<li>ALL,查询所有状态的印章;</li>
|
|
9992
|
+
<li>CHECKING,查询待审核的印章;</li>
|
|
9993
|
+
<li>SUCCESS,查询启用状态的印章;</li>
|
|
9994
|
+
<li>FAIL,查询印章审核拒绝的印章;</li>
|
|
9995
|
+
<li>DISABLE,查询已停用的印章;</li>
|
|
9996
|
+
<li>STOPPED,查询已终止的印章;</li>
|
|
9997
|
+
<li>VOID,查询已作废的印章;</li>
|
|
9998
|
+
<li>INVALID,查询已失效的印章;</li>
|
|
9999
|
+
</ul>
|
|
9911
10000
|
:type SealStatuses: list of str
|
|
9912
10001
|
"""
|
|
9913
10002
|
self._Operator = None
|
|
@@ -12073,40 +12162,28 @@ class FlowDetailInfo(AbstractModel):
|
|
|
12073
12162
|
|
|
12074
12163
|
def __init__(self):
|
|
12075
12164
|
r"""
|
|
12076
|
-
:param _FlowId:
|
|
12165
|
+
:param _FlowId: 合同流程ID,为32位字符串。
|
|
12077
12166
|
:type FlowId: str
|
|
12078
|
-
:param _FlowName:
|
|
12167
|
+
:param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
12079
12168
|
:type FlowName: str
|
|
12080
|
-
:param _FlowType:
|
|
12169
|
+
:param _FlowType: 合同流程的类别分类(如销售合同/入职合同等)。
|
|
12081
12170
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
12082
12171
|
:type FlowType: str
|
|
12083
|
-
:param _FlowStatus:
|
|
12084
|
-
- 0 还没有发起
|
|
12085
|
-
- 1 待签署
|
|
12086
|
-
- 2 部分签署
|
|
12087
|
-
- 3 已拒签
|
|
12088
|
-
- 4 已签署
|
|
12089
|
-
- 5 已过期
|
|
12090
|
-
- 6 已撤销
|
|
12091
|
-
- 7 还没有预发起
|
|
12092
|
-
- 8 等待填写
|
|
12093
|
-
- 9 部分填写
|
|
12094
|
-
- 10 拒填
|
|
12095
|
-
- 21 已解除
|
|
12172
|
+
:param _FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值 <ul><li> **0** : 未开启流程(合同中不存在填写环节)</li> <li> **1** : 待签署</li> <li> **2** : 部分签署</li> <li> **3** : 已拒签</li> <li> **4** : 已签署</li> <li> **5** : 已过期</li> <li> **6** : 已撤销</li> <li> **7** : 未开启流程(合同中存在填写环节)</li> <li> **8** : 等待填写</li> <li> **9** : 部分填写</li> <li> **10** : 已拒填</li> <li> **21** : 已解除</li></ul>
|
|
12096
12173
|
:type FlowStatus: int
|
|
12097
|
-
:param _FlowMessage:
|
|
12174
|
+
:param _FlowMessage: 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
|
|
12098
12175
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
12099
12176
|
:type FlowMessage: str
|
|
12100
|
-
:param _FlowDescription:
|
|
12177
|
+
:param _FlowDescription: 合同流程描述信息。
|
|
12101
12178
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
12102
12179
|
:type FlowDescription: str
|
|
12103
|
-
:param _CreatedOn:
|
|
12180
|
+
:param _CreatedOn: 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
|
|
12104
12181
|
:type CreatedOn: int
|
|
12105
|
-
:param _FlowApproverInfos:
|
|
12182
|
+
:param _FlowApproverInfos: 合同流程的签署方数组
|
|
12106
12183
|
:type FlowApproverInfos: list of FlowApproverDetail
|
|
12107
|
-
:param _CcInfos:
|
|
12184
|
+
:param _CcInfos: 合同流程的关注方信息数组
|
|
12108
12185
|
:type CcInfos: list of FlowApproverDetail
|
|
12109
|
-
:param _Creator:
|
|
12186
|
+
:param _Creator: 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
|
|
12110
12187
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
12111
12188
|
:type Creator: str
|
|
12112
12189
|
"""
|
|
@@ -14620,11 +14697,13 @@ class RecipientComponentInfo(AbstractModel):
|
|
|
14620
14697
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
14621
14698
|
:type RecipientId: str
|
|
14622
14699
|
:param _RecipientFillStatus: 参与方填写状态
|
|
14623
|
-
0
|
|
14624
|
-
1
|
|
14700
|
+
<ul><li>0-未填写</li>
|
|
14701
|
+
<li>1-已填写</li></ul>
|
|
14625
14702
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
14626
14703
|
:type RecipientFillStatus: str
|
|
14627
14704
|
:param _IsPromoter: 是否为发起方
|
|
14705
|
+
<ul><li>true-发起方</li>
|
|
14706
|
+
<li>false-参与方</li></ul>
|
|
14628
14707
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
14629
14708
|
:type IsPromoter: bool
|
|
14630
14709
|
:param _Components: 填写控件列表
|
|
@@ -16788,13 +16867,19 @@ class VerifyPdfRequest(AbstractModel):
|
|
|
16788
16867
|
|
|
16789
16868
|
def __init__(self):
|
|
16790
16869
|
r"""
|
|
16791
|
-
:param _FlowId:
|
|
16870
|
+
:param _FlowId: 合同流程ID,为32位字符串。
|
|
16871
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
16792
16872
|
:type FlowId: str
|
|
16793
|
-
:param _Operator:
|
|
16873
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
16874
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
16794
16875
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
16876
|
+
:param _Agent: 代理企业和员工的信息。
|
|
16877
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
16878
|
+
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
16795
16879
|
"""
|
|
16796
16880
|
self._FlowId = None
|
|
16797
16881
|
self._Operator = None
|
|
16882
|
+
self._Agent = None
|
|
16798
16883
|
|
|
16799
16884
|
@property
|
|
16800
16885
|
def FlowId(self):
|
|
@@ -16812,12 +16897,23 @@ class VerifyPdfRequest(AbstractModel):
|
|
|
16812
16897
|
def Operator(self, Operator):
|
|
16813
16898
|
self._Operator = Operator
|
|
16814
16899
|
|
|
16900
|
+
@property
|
|
16901
|
+
def Agent(self):
|
|
16902
|
+
return self._Agent
|
|
16903
|
+
|
|
16904
|
+
@Agent.setter
|
|
16905
|
+
def Agent(self, Agent):
|
|
16906
|
+
self._Agent = Agent
|
|
16907
|
+
|
|
16815
16908
|
|
|
16816
16909
|
def _deserialize(self, params):
|
|
16817
16910
|
self._FlowId = params.get("FlowId")
|
|
16818
16911
|
if params.get("Operator") is not None:
|
|
16819
16912
|
self._Operator = UserInfo()
|
|
16820
16913
|
self._Operator._deserialize(params.get("Operator"))
|
|
16914
|
+
if params.get("Agent") is not None:
|
|
16915
|
+
self._Agent = Agent()
|
|
16916
|
+
self._Agent._deserialize(params.get("Agent"))
|
|
16821
16917
|
memeber_set = set(params.keys())
|
|
16822
16918
|
for name, value in vars(self).items():
|
|
16823
16919
|
property_name = name[1:]
|
|
@@ -16835,11 +16931,22 @@ class VerifyPdfResponse(AbstractModel):
|
|
|
16835
16931
|
|
|
16836
16932
|
def __init__(self):
|
|
16837
16933
|
r"""
|
|
16838
|
-
:param _VerifyResult:
|
|
16934
|
+
:param _VerifyResult: 验签结果代码,代码的含义如下:
|
|
16935
|
+
|
|
16936
|
+
<ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
|
|
16937
|
+
<li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
|
|
16938
|
+
<li>**3**:文件被篡改。</li>
|
|
16939
|
+
<li>**4**:异常:文件内没有签名域。</li>
|
|
16940
|
+
<li>**5**:异常:文件签名格式错误。</li></ul>
|
|
16839
16941
|
:type VerifyResult: int
|
|
16840
|
-
:param _PdfVerifyResults:
|
|
16942
|
+
:param _PdfVerifyResults: 验签结果详情,每个签名域对应的验签结果。状态值如下
|
|
16943
|
+
<ul><li> **1** :验签成功,在电子签签署</li>
|
|
16944
|
+
<li> **2** :验签成功,在其他平台签署</li>
|
|
16945
|
+
<li> **3** :验签失败</li>
|
|
16946
|
+
<li> **4** :pdf文件没有签名域</li>
|
|
16947
|
+
<li> **5** :文件签名格式错误</li></ul>
|
|
16841
16948
|
:type PdfVerifyResults: list of PdfVerifyResult
|
|
16842
|
-
:param _VerifySerialNo:
|
|
16949
|
+
:param _VerifySerialNo: 验签序列号, 为11为数组组成的字符串
|
|
16843
16950
|
:type VerifySerialNo: str
|
|
16844
16951
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
16845
16952
|
:type RequestId: str
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
tencentcloud-sdk-python-common==3.0.985
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
tencentcloud-sdk-python-common==3.0.983
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|