tencentcloud-sdk-ess 3.0.662 → 3.0.663
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +25 -21
- data/lib/v20201111/models.rb +265 -174
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a137543ecf5d04b21d7194d814ed9f819149de5e
|
4
|
+
data.tar.gz: 7955fdc9598e96d9e008f70852cd16d09b2477e3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4898a9582bf84a20db394425c8d590f2c9d453186a35575eede829fda945849f0da3a0171f972d81d9dbc229def68b9fb31f8eff07f595b85d8fe0fbc1ce25d5
|
7
|
+
data.tar.gz: 5c78cee1dbc1d829d7f7e78bb1edac5d3ef2bfd48ac90889dfd7043454403b19a9f5c34486b1f3d58efd64aa93c623e1c7e01e6cfb75866a59eaec118049207f
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.663
|
data/lib/v20201111/client.rb
CHANGED
@@ -220,9 +220,11 @@ module TencentCloud
|
|
220
220
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
221
221
|
end
|
222
222
|
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
223
|
+
# 创建签署流程电子文档<br />
|
224
|
+
# 适用场景:见创建签署流程接口。<br />
|
225
|
+
# 点击查看<a href="https://qian.tencent.com/developers/startFlows/CreateFlow" target="_blank">通过模板创建签署流程</a>
|
226
|
+
# <a href="https://qian.tencent.com/developers/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>。<br />
|
227
|
+
# 注:该接口需要给对应的流程指定一个模板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>接口使用。具体逻辑可以参考下图:
|
226
228
|
|
227
229
|
# <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>
|
228
230
|
|
@@ -741,9 +743,9 @@ module TencentCloud
|
|
741
743
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
742
744
|
end
|
743
745
|
|
744
|
-
#
|
745
|
-
# <br
|
746
|
-
# <br
|
746
|
+
# 创建发起流程web页面
|
747
|
+
# <br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
|
748
|
+
# <br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
|
747
749
|
|
748
750
|
# @param request: Request instance for CreatePrepareFlow.
|
749
751
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreatePrepareFlowRequest`
|
@@ -887,7 +889,7 @@ module TencentCloud
|
|
887
889
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
888
890
|
end
|
889
891
|
|
890
|
-
#
|
892
|
+
# 本接口(CreateSealPolicy)用于对企业员工进行印章授权
|
891
893
|
|
892
894
|
# @param request: Request instance for CreateSealPolicy.
|
893
895
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateSealPolicyRequest`
|
@@ -937,8 +939,9 @@ module TencentCloud
|
|
937
939
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
938
940
|
end
|
939
941
|
|
940
|
-
#
|
941
|
-
|
942
|
+
# 用来设置本企业嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),设置后获取的web签署界面都会使用此配置进行展示。
|
943
|
+
|
944
|
+
# 如果多次调用,会以最后一次的配置为准
|
942
945
|
|
943
946
|
# @param request: Request instance for CreateWebThemeConfig.
|
944
947
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateWebThemeConfigRequest`
|
@@ -1038,7 +1041,7 @@ module TencentCloud
|
|
1038
1041
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1039
1042
|
end
|
1040
1043
|
|
1041
|
-
#
|
1044
|
+
# 本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限
|
1042
1045
|
|
1043
1046
|
# @param request: Request instance for DeleteSealPolicies.
|
1044
1047
|
# @type request: :class:`Tencentcloud::ess::V20201111::DeleteSealPoliciesRequest`
|
@@ -1091,7 +1094,7 @@ module TencentCloud
|
|
1091
1094
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1092
1095
|
end
|
1093
1096
|
|
1094
|
-
#
|
1097
|
+
# 本接口(DescribeFileUrls)用于查询文件的下载URL。
|
1095
1098
|
# 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
1096
1099
|
|
1097
1100
|
# @param request: Request instance for DescribeFileUrls.
|
@@ -1143,7 +1146,7 @@ module TencentCloud
|
|
1143
1146
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1144
1147
|
end
|
1145
1148
|
|
1146
|
-
#
|
1149
|
+
# 查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
|
1147
1150
|
|
1148
1151
|
# @param request: Request instance for DescribeFlowComponents.
|
1149
1152
|
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowComponentsRequest`
|
@@ -1199,7 +1202,8 @@ module TencentCloud
|
|
1199
1202
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1200
1203
|
end
|
1201
1204
|
|
1202
|
-
#
|
1205
|
+
# 接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100)
|
1206
|
+
|
1203
1207
|
# 适用场景:可用于主动查询某个合同详情信息。
|
1204
1208
|
|
1205
1209
|
# @param request: Request instance for DescribeFlowInfo.
|
@@ -1224,13 +1228,7 @@ module TencentCloud
|
|
1224
1228
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1225
1229
|
end
|
1226
1230
|
|
1227
|
-
#
|
1228
|
-
|
1229
|
-
# 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
|
1230
|
-
|
1231
|
-
# > **适用场景**
|
1232
|
-
# >
|
1233
|
-
# > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
|
1231
|
+
# 此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。
|
1234
1232
|
# > 一个模板通常会包含以下结构信息
|
1235
1233
|
# >- 模板基本信息
|
1236
1234
|
# >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
@@ -1238,6 +1236,12 @@ module TencentCloud
|
|
1238
1236
|
# >- 签署控件 SignComponents
|
1239
1237
|
# >- 生成模板的文件基础信息 FileInfos
|
1240
1238
|
|
1239
|
+
# 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
|
1240
|
+
|
1241
|
+
# 适用场景:
|
1242
|
+
# 该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口,作为创建电子文档的前置接口使用。
|
1243
|
+
# 通过此接口查询到模板信息后,再通过调用创建电子文档接口,指定模板ID,指定模板中需要的填写控件内容等,完成电子文档的创建。
|
1244
|
+
|
1241
1245
|
# @param request: Request instance for DescribeFlowTemplates.
|
1242
1246
|
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest`
|
1243
1247
|
# @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesResponse`
|
@@ -1688,7 +1692,7 @@ module TencentCloud
|
|
1688
1692
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1689
1693
|
end
|
1690
1694
|
|
1691
|
-
#
|
1695
|
+
# 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
|
1692
1696
|
|
1693
1697
|
# @param request: Request instance for VerifyPdf.
|
1694
1698
|
# @type request: :class:`Tencentcloud::ess::V20201111::VerifyPdfRequest`
|
data/lib/v20201111/models.rb
CHANGED
@@ -1288,6 +1288,7 @@ module TencentCloud
|
|
1288
1288
|
# @param NeedPreview: 是否为预览模式,取值如下:
|
1289
1289
|
# <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
1290
1290
|
# <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
1291
|
+
# 注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
|
1291
1292
|
# @type NeedPreview: Boolean
|
1292
1293
|
# @param PreviewType: 预览模式下产生的预览链接类型
|
1293
1294
|
# <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
@@ -1349,7 +1350,8 @@ module TencentCloud
|
|
1349
1350
|
# @type DocumentId: String
|
1350
1351
|
# @param PreviewFileUrl: 合同预览链接URL。
|
1351
1352
|
|
1352
|
-
#
|
1353
|
+
# 注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
|
1354
|
+
# `2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
|
1353
1355
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1354
1356
|
# @type PreviewFileUrl: String
|
1355
1357
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
@@ -1969,44 +1971,44 @@ module TencentCloud
|
|
1969
1971
|
# 创建合同个性化参数
|
1970
1972
|
class CreateFlowOption < TencentCloud::Common::AbstractModel
|
1971
1973
|
# @param CanEditFlow: 是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。
|
1972
|
-
# <br/>true
|
1974
|
+
# <br/>true:允许编辑<br/>false:不允许编辑(默认值)<br/>
|
1973
1975
|
# @type CanEditFlow: Boolean
|
1974
1976
|
# @param CanEditFormField: 是否允许编辑模板控件
|
1975
1977
|
# <br/>true:允许编辑模板控件信息
|
1976
|
-
# <br/>false
|
1977
|
-
# <br
|
1978
|
+
# <br/>false:不允许编辑模板控件信息(默认值)
|
1979
|
+
# <br/>
|
1978
1980
|
# @type CanEditFormField: Boolean
|
1979
1981
|
# @param HideShowFlowName: 发起页面隐藏合同名称展示
|
1980
1982
|
# <br/>true:发起页面隐藏合同名称展示
|
1981
|
-
# <br/>false
|
1982
|
-
# <br
|
1983
|
+
# <br/>false:发起页面不隐藏合同名称展示(默认值)
|
1984
|
+
# <br/>
|
1983
1985
|
# @type HideShowFlowName: Boolean
|
1984
1986
|
# @param HideShowFlowType: 发起页面隐藏合同类型展示
|
1985
1987
|
# <br/>true:发起页面隐藏合同类型展示
|
1986
|
-
# <br/>false
|
1987
|
-
# <br
|
1988
|
+
# <br/>false:发起页面不隐藏合同类型展示(默认值)
|
1989
|
+
# <br/>
|
1988
1990
|
# @type HideShowFlowType: Boolean
|
1989
1991
|
# @param HideShowDeadline: 发起页面隐藏合同截止日期展示
|
1990
1992
|
# <br/>true:发起页面隐藏合同截止日期展示
|
1991
|
-
# <br/>false
|
1992
|
-
# <br
|
1993
|
+
# <br/>false:发起页面不隐藏合同截止日期展示(默认值)
|
1994
|
+
# <br/>
|
1993
1995
|
# @type HideShowDeadline: Boolean
|
1994
1996
|
# @param CanSkipAddApprover: 发起页面允许跳过添加签署人环节
|
1995
1997
|
# <br/>true:发起页面允许跳过添加签署人环节
|
1996
|
-
# <br/>false
|
1997
|
-
# <br
|
1998
|
+
# <br/>false:发起页面不允许跳过添加签署人环节(默认值)
|
1999
|
+
# <br/>
|
1998
2000
|
# @type CanSkipAddApprover: Boolean
|
1999
2001
|
# @param SkipUploadFile: 文件发起页面跳过文件上传步骤
|
2000
2002
|
# <br/>true:文件发起页面跳过文件上传步骤
|
2001
|
-
# <br/>false
|
2002
|
-
# <br
|
2003
|
+
# <br/>false:文件发起页面不跳过文件上传步骤(默认值)
|
2004
|
+
# <br/>
|
2003
2005
|
# @type SkipUploadFile: Boolean
|
2004
2006
|
# @param ForbidEditFillComponent: 禁止编辑填写控件
|
2005
2007
|
# <br/>true:禁止编辑填写控件
|
2006
|
-
# <br/>false
|
2007
|
-
# <br
|
2008
|
+
# <br/>false:允许编辑填写控件(默认值)
|
2009
|
+
# <br/>
|
2008
2010
|
# @type ForbidEditFillComponent: Boolean
|
2009
|
-
# @param CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500
|
2011
|
+
# @param CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500字符
|
2010
2012
|
# @type CustomCreateFlowDescription: String
|
2011
2013
|
|
2012
2014
|
attr_accessor :CanEditFlow, :CanEditFormField, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :SkipUploadFile, :ForbidEditFillComponent, :CustomCreateFlowDescription
|
@@ -2997,67 +2999,79 @@ module TencentCloud
|
|
2997
2999
|
|
2998
3000
|
# CreatePrepareFlow请求参数结构体
|
2999
3001
|
class CreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
|
3000
|
-
# @param Operator:
|
3002
|
+
# @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
3003
|
+
# 支持填入集团子公司经办人 userId 代发合同。
|
3004
|
+
|
3005
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3001
3006
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3002
|
-
# @param ResourceId: 资源id,与ResourceType
|
3007
|
+
# @param ResourceId: 资源id,与ResourceType相对应,取值范围:
|
3008
|
+
# <ul>
|
3009
|
+
# <li>文件Id(通过UploadFiles获取文件资源Id)</li>
|
3010
|
+
# <li>模板Id</li>
|
3011
|
+
# </ul>
|
3003
3012
|
# @type ResourceId: String
|
3004
|
-
# @param FlowName:
|
3013
|
+
# @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
3005
3014
|
# @type FlowName: String
|
3006
|
-
# @param Unordered:
|
3007
|
-
#
|
3008
|
-
#
|
3015
|
+
# @param Unordered: 合同流程的签署顺序类型:
|
3016
|
+
# <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
3017
|
+
# <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
3009
3018
|
# @type Unordered: Boolean
|
3010
|
-
# @param Deadline:
|
3011
|
-
# 值为unix时间戳,精确到秒
|
3012
|
-
# 不传默认为当前时间一年后
|
3019
|
+
# @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
3013
3020
|
# @type Deadline: Integer
|
3014
3021
|
# @param UserFlowTypeId: 用户自定义合同类型Id
|
3015
3022
|
|
3016
|
-
# 该id为电子签企业内的合同类型id,
|
3023
|
+
# 该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
|
3024
|
+
# 注: `该参数如果和FlowType同时传,以该参数优先生效`
|
3017
3025
|
# @type UserFlowTypeId: String
|
3018
|
-
# @param FlowType:
|
3019
|
-
# 该字段用于客户自定义合同类型
|
3020
|
-
# 建议使用时指定合同类型,便于之后合同分类以及查看
|
3021
|
-
# 如果合同类型与自定义的合同类型描述一致,会自动归类到自定义的合同类型处,如果不一致,则会创建一个新的自定义合同类型
|
3026
|
+
# @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
3022
3027
|
# @type FlowType: String
|
3023
|
-
# @param Approvers:
|
3028
|
+
# @param Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
3029
|
+
|
3030
|
+
# 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
3024
3031
|
# @type Approvers: Array
|
3025
|
-
# @param IntelligentStatus:
|
3026
|
-
#
|
3027
|
-
#
|
3032
|
+
# @param IntelligentStatus: 开启或者关闭智能添加填写区:
|
3033
|
+
# <ul><li> **OPEN**:开启(默认值)</li>
|
3034
|
+
# <li> **CLOSE**:关闭</li></ul>
|
3028
3035
|
# @type IntelligentStatus: String
|
3029
|
-
# @param ResourceType:
|
3030
|
-
# 1
|
3031
|
-
# 2
|
3032
|
-
# 不传默认为2:文件
|
3036
|
+
# @param ResourceType: 资源类型,取值有:
|
3037
|
+
# <ul><li> **1**:模板</li>
|
3038
|
+
# <li> **2**:文件(默认值)</li></ul>
|
3033
3039
|
# @type ResourceType: Integer
|
3034
|
-
# @param Components:
|
3035
|
-
# 该类型控件由发起方完成填写
|
3040
|
+
# @param Components: 该字段已废弃,请使用InitiatorComponents
|
3036
3041
|
# @type Components: :class:`Tencentcloud::Ess.v20201111.models.Component`
|
3037
3042
|
# @param FlowOption: 发起合同个性化参数
|
3038
3043
|
# 用于满足创建及页面操作过程中的个性化要求
|
3039
3044
|
# 具体定制化内容详见数据接口说明
|
3040
3045
|
# @type FlowOption: :class:`Tencentcloud::Ess.v20201111.models.CreateFlowOption`
|
3041
|
-
# @param NeedSignReview:
|
3042
|
-
#
|
3043
|
-
#
|
3044
|
-
#
|
3046
|
+
# @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
3047
|
+
# <ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
3048
|
+
# <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
3049
|
+
# 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
3050
|
+
# <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
3051
|
+
# <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
3052
|
+
# 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
3045
3053
|
# @type NeedSignReview: Boolean
|
3046
|
-
# @param NeedCreateReview:
|
3047
|
-
|
3048
|
-
#
|
3049
|
-
|
3054
|
+
# @param NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
3055
|
+
|
3056
|
+
# 若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
|
3057
|
+
|
3050
3058
|
# @type NeedCreateReview: Boolean
|
3051
|
-
# @param UserData:
|
3059
|
+
# @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
3060
|
+
|
3061
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
3052
3062
|
# @type UserData: String
|
3053
|
-
# @param FlowId: 合同
|
3063
|
+
# @param FlowId: 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
|
3064
|
+
# 注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
|
3054
3065
|
# @type FlowId: String
|
3055
|
-
# @param Agent:
|
3066
|
+
# @param Agent: 代理企业和员工的信息。
|
3067
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3056
3068
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3069
|
+
# @param InitiatorComponents: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
3070
|
+
# @type InitiatorComponents: Array
|
3057
3071
|
|
3058
|
-
attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :FlowType, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :Agent
|
3072
|
+
attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :FlowType, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :Agent, :InitiatorComponents
|
3059
3073
|
|
3060
|
-
def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, flowtype=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, agent=nil)
|
3074
|
+
def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, flowtype=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, agent=nil, initiatorcomponents=nil)
|
3061
3075
|
@Operator = operator
|
3062
3076
|
@ResourceId = resourceid
|
3063
3077
|
@FlowName = flowname
|
@@ -3075,6 +3089,7 @@ module TencentCloud
|
|
3075
3089
|
@UserData = userdata
|
3076
3090
|
@FlowId = flowid
|
3077
3091
|
@Agent = agent
|
3092
|
+
@InitiatorComponents = initiatorcomponents
|
3078
3093
|
end
|
3079
3094
|
|
3080
3095
|
def deserialize(params)
|
@@ -3114,12 +3129,20 @@ module TencentCloud
|
|
3114
3129
|
@Agent = Agent.new
|
3115
3130
|
@Agent.deserialize(params['Agent'])
|
3116
3131
|
end
|
3132
|
+
unless params['InitiatorComponents'].nil?
|
3133
|
+
@InitiatorComponents = []
|
3134
|
+
params['InitiatorComponents'].each do |i|
|
3135
|
+
component_tmp = Component.new
|
3136
|
+
component_tmp.deserialize(i)
|
3137
|
+
@InitiatorComponents << component_tmp
|
3138
|
+
end
|
3139
|
+
end
|
3117
3140
|
end
|
3118
3141
|
end
|
3119
3142
|
|
3120
3143
|
# CreatePrepareFlow返回参数结构体
|
3121
3144
|
class CreatePrepareFlowResponse < TencentCloud::Common::AbstractModel
|
3122
|
-
# @param Url:
|
3145
|
+
# @param Url: 发起流程的web页面链接,有效期5分钟
|
3123
3146
|
# @type Url: String
|
3124
3147
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3125
3148
|
# @type RequestId: String
|
@@ -3141,18 +3164,20 @@ module TencentCloud
|
|
3141
3164
|
class CreatePreparedPersonalEsignRequest < TencentCloud::Common::AbstractModel
|
3142
3165
|
# @param UserName: 个人用户姓名
|
3143
3166
|
# @type UserName: String
|
3144
|
-
# @param IdCardNumber:
|
3167
|
+
# @param IdCardNumber: 证件号码,应符合以下规则
|
3168
|
+
# <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
3169
|
+
# <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
3170
|
+
# <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
3145
3171
|
# @type IdCardNumber: String
|
3146
|
-
# @param SealName:
|
3172
|
+
# @param SealName: 印章名称,长度1-50个字。
|
3147
3173
|
# @type SealName: String
|
3148
|
-
# @param Operator:
|
3174
|
+
# @param Operator: 执行本接口操作的员工信息。
|
3175
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3149
3176
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3150
|
-
# @param IdCardType:
|
3151
|
-
# ID_CARD
|
3152
|
-
#
|
3153
|
-
#
|
3154
|
-
# FOREIGN_ID_CARD 境外身份
|
3155
|
-
# HONGKONG_MACAO_AND_TAIWAN 中国台湾
|
3177
|
+
# @param IdCardType: 证件类型,支持以下类型
|
3178
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
3179
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
3180
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
3156
3181
|
# @type IdCardType: String
|
3157
3182
|
# @param SealImage: 印章图片的base64
|
3158
3183
|
# 注:已废弃
|
@@ -3171,16 +3196,19 @@ module TencentCloud
|
|
3171
3196
|
# RED 红色,
|
3172
3197
|
# BLUE 蓝色。
|
3173
3198
|
# @type SealColor: String
|
3174
|
-
# @param ProcessSeal:
|
3175
|
-
#
|
3176
|
-
#
|
3177
|
-
#
|
3199
|
+
# @param ProcessSeal: 是否处理印章,默认不做印章处理。
|
3200
|
+
# 取值如下:
|
3201
|
+
# <ul>
|
3202
|
+
# <li>false:不做任何处理;</li>
|
3203
|
+
# <li>true:做透明化处理和颜色增强。</li>
|
3204
|
+
# </ul>
|
3178
3205
|
# @type ProcessSeal: Boolean
|
3179
3206
|
# @param FileId: 印章图片文件 id
|
3180
3207
|
# 取值:
|
3181
3208
|
# 填写的FileId通过UploadFiles接口上传文件获取。
|
3182
3209
|
# @type FileId: String
|
3183
|
-
# @param Agent:
|
3210
|
+
# @param Agent: 代理企业和员工的信息。
|
3211
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3184
3212
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3185
3213
|
# @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减
|
3186
3214
|
# @type LicenseType: Integer
|
@@ -3233,7 +3261,8 @@ module TencentCloud
|
|
3233
3261
|
|
3234
3262
|
# CreatePreparedPersonalEsign返回参数结构体
|
3235
3263
|
class CreatePreparedPersonalEsignResponse < TencentCloud::Common::AbstractModel
|
3236
|
-
# @param SealId: 导入生成的印章ID
|
3264
|
+
# @param SealId: 导入生成的印章ID,为32位字符串。
|
3265
|
+
# 建议开发者保存此印章ID,开头实名认证后,通过此 ID查询导入的印章。
|
3237
3266
|
# @type SealId: String
|
3238
3267
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3239
3268
|
# @type RequestId: String
|
@@ -3448,11 +3477,14 @@ module TencentCloud
|
|
3448
3477
|
|
3449
3478
|
# CreateSealPolicy请求参数结构体
|
3450
3479
|
class CreateSealPolicyRequest < TencentCloud::Common::AbstractModel
|
3451
|
-
# @param Operator:
|
3480
|
+
# @param Operator: 执行本接口操作的员工信息。
|
3481
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3452
3482
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3453
3483
|
# @param Users: 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用
|
3454
3484
|
# @type Users: Array
|
3455
|
-
# @param SealId:
|
3485
|
+
# @param SealId: 电子印章ID,为32位字符串。
|
3486
|
+
# 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
3487
|
+
# 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
3456
3488
|
# @type SealId: String
|
3457
3489
|
# @param Expired: 授权有效期。时间戳秒级
|
3458
3490
|
# @type Expired: Integer
|
@@ -3460,7 +3492,8 @@ module TencentCloud
|
|
3460
3492
|
# @type UserIds: Array
|
3461
3493
|
# @param Policy: 印章授权内容
|
3462
3494
|
# @type Policy: String
|
3463
|
-
# @param Agent:
|
3495
|
+
# @param Agent: 代理企业和员工的信息。
|
3496
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3464
3497
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3465
3498
|
|
3466
3499
|
attr_accessor :Operator, :Users, :SealId, :Expired, :UserIds, :Policy, :Agent
|
@@ -3501,7 +3534,8 @@ module TencentCloud
|
|
3501
3534
|
|
3502
3535
|
# CreateSealPolicy返回参数结构体
|
3503
3536
|
class CreateSealPolicyResponse < TencentCloud::Common::AbstractModel
|
3504
|
-
# @param UserIds:
|
3537
|
+
# @param UserIds: 最终授权成功的用户ID,在腾讯电子签平台的唯一身份标识,为32位字符串。
|
3538
|
+
# 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
3505
3539
|
# @type UserIds: Array
|
3506
3540
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3507
3541
|
# @type RequestId: String
|
@@ -3534,10 +3568,12 @@ module TencentCloud
|
|
3534
3568
|
# 如果要使用图片上传请传字段 Image
|
3535
3569
|
# @type GenerateSource: String
|
3536
3570
|
# @param SealType: 电子印章类型:
|
3537
|
-
#
|
3538
|
-
#
|
3539
|
-
#
|
3540
|
-
#
|
3571
|
+
# <ul>
|
3572
|
+
# <li>OFFICIAL-公章;</li>
|
3573
|
+
# <li>CONTRACT-合同专用章;</li>
|
3574
|
+
# <li>FINANCE-合财务专用章;</li>
|
3575
|
+
# <li>PERSONNEL-人事专用章.</li>
|
3576
|
+
# </ul>
|
3541
3577
|
# @type SealType: String
|
3542
3578
|
# @param FileName: 电子印章图片文件名称,1-50个中文字符。
|
3543
3579
|
# @type FileName: String
|
@@ -3562,16 +3598,20 @@ module TencentCloud
|
|
3562
3598
|
# @type SealCentralType: String
|
3563
3599
|
# @param FileToken: 通过文件上传时,服务端生成的电子印章上传图片的token
|
3564
3600
|
# @type FileToken: String
|
3565
|
-
# @param SealStyle:
|
3601
|
+
# @param SealStyle: 印章样式,取值如下:
|
3566
3602
|
|
3567
|
-
#
|
3568
|
-
#
|
3569
|
-
#
|
3603
|
+
# <ul>
|
3604
|
+
# <li>cycle:圆形印章;</li>
|
3605
|
+
# <li>ellipse:椭圆印章;</li>
|
3606
|
+
# <li>注:默认圆形印章</li>
|
3607
|
+
# </ul>
|
3570
3608
|
# @type SealStyle: String
|
3571
3609
|
# @param SealSize: 印章尺寸取值描述:
|
3572
|
-
#
|
3573
|
-
#
|
3574
|
-
#
|
3610
|
+
# <ul>
|
3611
|
+
# <li>42_42 圆形企业公章直径42mm;</li>
|
3612
|
+
# <li>40_40 圆形企业印章直径40mm;</li>
|
3613
|
+
# <li>45_30 椭圆形印章45mm x 30mm;</li>
|
3614
|
+
# </ul>
|
3575
3615
|
# @type SealSize: String
|
3576
3616
|
|
3577
3617
|
attr_accessor :Operator, :SealName, :Agent, :GenerateSource, :SealType, :FileName, :Image, :Width, :Height, :Color, :SealHorizontalText, :SealChordText, :SealCentralType, :FileToken, :SealStyle, :SealSize
|
@@ -3623,7 +3663,9 @@ module TencentCloud
|
|
3623
3663
|
|
3624
3664
|
# CreateSeal返回参数结构体
|
3625
3665
|
class CreateSealResponse < TencentCloud::Common::AbstractModel
|
3626
|
-
# @param SealId:
|
3666
|
+
# @param SealId: 电子印章ID,为32位字符串。
|
3667
|
+
# 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
3668
|
+
# 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
3627
3669
|
# @type SealId: String
|
3628
3670
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3629
3671
|
# @type RequestId: String
|
@@ -3797,7 +3839,7 @@ module TencentCloud
|
|
3797
3839
|
# <ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
|
3798
3840
|
# </ul>
|
3799
3841
|
# @type ThemeType: String
|
3800
|
-
# @param WebThemeConfig:
|
3842
|
+
# @param WebThemeConfig: 电子签logo是否展示,主体颜色等配置项
|
3801
3843
|
# @type WebThemeConfig: :class:`Tencentcloud::Ess.v20201111.models.WebThemeConfig`
|
3802
3844
|
# @param Agent: 代理企业和员工的信息。
|
3803
3845
|
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
@@ -4027,15 +4069,21 @@ module TencentCloud
|
|
4027
4069
|
|
4028
4070
|
# DeleteSealPolicies请求参数结构体
|
4029
4071
|
class DeleteSealPoliciesRequest < TencentCloud::Common::AbstractModel
|
4030
|
-
# @param Operator:
|
4072
|
+
# @param Operator: 执行本接口操作的员工信息。
|
4073
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4031
4074
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4032
4075
|
# @param PolicyIds: 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
|
4033
4076
|
# @type PolicyIds: Array
|
4034
|
-
# @param SealId:
|
4077
|
+
# @param SealId: 电子印章ID,为32位字符串。
|
4078
|
+
# 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
4079
|
+
# 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
4080
|
+
# 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
|
4035
4081
|
# @type SealId: String
|
4036
|
-
# @param UserIds: 待授权的员工ID
|
4082
|
+
# @param UserIds: 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
4083
|
+
# 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
4037
4084
|
# @type UserIds: Array
|
4038
|
-
# @param Agent:
|
4085
|
+
# @param Agent: 代理企业和员工的信息。
|
4086
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4039
4087
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4040
4088
|
|
4041
4089
|
attr_accessor :Operator, :PolicyIds, :SealId, :UserIds, :Agent
|
@@ -4203,24 +4251,38 @@ module TencentCloud
|
|
4203
4251
|
|
4204
4252
|
# DescribeFileUrls请求参数结构体
|
4205
4253
|
class DescribeFileUrlsRequest < TencentCloud::Common::AbstractModel
|
4206
|
-
# @param Operator:
|
4254
|
+
# @param Operator: 执行本接口操作的员工信息。
|
4255
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4207
4256
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4208
4257
|
# @param BusinessType: 文件对应的业务类型,目前支持:
|
4209
|
-
#
|
4210
|
-
#
|
4211
|
-
#
|
4212
|
-
#
|
4258
|
+
# <ul>
|
4259
|
+
# <li>FLOW 如需下载合同文件请选择此项</li>
|
4260
|
+
# <li>TEMPLATE 如需下载模板文件请选择此项</li>
|
4261
|
+
# <li>DOCUMENT 如需下载文档文件请选择此项</li>
|
4262
|
+
# <li>SEAL 如需下载印章图片请选择此项</li>
|
4263
|
+
# </ul>
|
4213
4264
|
# @type BusinessType: String
|
4214
|
-
# @param BusinessIds:
|
4215
|
-
#
|
4265
|
+
# @param BusinessIds: 业务编号的数组,取值如下:
|
4266
|
+
# <ul>
|
4267
|
+
# <li>流程编号</li>
|
4268
|
+
# <li>模板编号</li>
|
4269
|
+
# <li>文档编号</li>
|
4270
|
+
# <li>印章编号</li>
|
4271
|
+
# <li>如需下载合同文件请传入FlowId,最大支持20个资源</li>
|
4272
|
+
# </ul>
|
4216
4273
|
# @type BusinessIds: Array
|
4217
4274
|
# @param FileName: 下载后的文件命名,只有FileType为zip的时候生效
|
4218
4275
|
# @type FileName: String
|
4219
|
-
# @param FileType:
|
4276
|
+
# @param FileType: 要下载的文件类型,取值如下:
|
4277
|
+
# <ul>
|
4278
|
+
# <li>JPG</li>
|
4279
|
+
# <li>PDF</li>
|
4280
|
+
# <li>ZIP</li>
|
4281
|
+
# </ul>
|
4220
4282
|
# @type FileType: String
|
4221
|
-
# @param Offset:
|
4283
|
+
# @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。
|
4222
4284
|
# @type Offset: Integer
|
4223
|
-
# @param Limit:
|
4285
|
+
# @param Limit: 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。
|
4224
4286
|
# @type Limit: Integer
|
4225
4287
|
# @param UrlTtl: 下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)
|
4226
4288
|
# @type UrlTtl: Integer
|
@@ -4371,11 +4433,15 @@ module TencentCloud
|
|
4371
4433
|
|
4372
4434
|
# DescribeFlowComponents请求参数结构体
|
4373
4435
|
class DescribeFlowComponentsRequest < TencentCloud::Common::AbstractModel
|
4374
|
-
# @param Operator:
|
4436
|
+
# @param Operator: 执行本接口操作的员工信息。
|
4437
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4375
4438
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4376
|
-
# @param FlowId:
|
4439
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
4440
|
+
# 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
4441
|
+
# 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
4377
4442
|
# @type FlowId: String
|
4378
|
-
# @param Agent:
|
4443
|
+
# @param Agent: 代理企业和员工的信息。
|
4444
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4379
4445
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4380
4446
|
|
4381
4447
|
attr_accessor :Operator, :FlowId, :Agent
|
@@ -4401,7 +4467,7 @@ module TencentCloud
|
|
4401
4467
|
|
4402
4468
|
# DescribeFlowComponents返回参数结构体
|
4403
4469
|
class DescribeFlowComponentsResponse < TencentCloud::Common::AbstractModel
|
4404
|
-
# @param RecipientComponentInfos:
|
4470
|
+
# @param RecipientComponentInfos: 合同流程关联的填写控件信息,按照参与方进行分类返回。
|
4405
4471
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
4406
4472
|
# @type RecipientComponentInfos: Array
|
4407
4473
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
@@ -4490,13 +4556,13 @@ module TencentCloud
|
|
4490
4556
|
|
4491
4557
|
# DescribeFlowInfo请求参数结构体
|
4492
4558
|
class DescribeFlowInfoRequest < TencentCloud::Common::AbstractModel
|
4493
|
-
# @param Operator:
|
4559
|
+
# @param Operator: 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4494
4560
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4495
4561
|
# @param FlowIds: 需要查询的流程ID列表,限制最大100个
|
4496
4562
|
|
4497
4563
|
# 如果查询合同组的信息,不要传此参数
|
4498
4564
|
# @type FlowIds: Array
|
4499
|
-
# @param Agent:
|
4565
|
+
# @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4500
4566
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4501
4567
|
# @param FlowGroupId: 合同组ID, 如果传此参数会忽略FlowIds入参
|
4502
4568
|
# 所以如传此参数不要传FlowIds参数
|
@@ -4529,7 +4595,7 @@ module TencentCloud
|
|
4529
4595
|
class DescribeFlowInfoResponse < TencentCloud::Common::AbstractModel
|
4530
4596
|
# @param FlowDetailInfos: 签署流程信息
|
4531
4597
|
# @type FlowDetailInfos: Array
|
4532
|
-
# @param FlowGroupId: 合同组ID
|
4598
|
+
# @param FlowGroupId: 合同组ID,为32位字符串
|
4533
4599
|
# @type FlowGroupId: String
|
4534
4600
|
# @param FlowGroupName: 合同组名称
|
4535
4601
|
# @type FlowGroupName: String
|
@@ -4562,28 +4628,32 @@ module TencentCloud
|
|
4562
4628
|
|
4563
4629
|
# DescribeFlowTemplates请求参数结构体
|
4564
4630
|
class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
|
4565
|
-
# @param Operator:
|
4566
|
-
#
|
4567
|
-
# 注:请保证员工有相关的角色权限
|
4631
|
+
# @param Operator: 执行本接口操作的员工信息。
|
4632
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4568
4633
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4569
|
-
# @param Agent:
|
4570
|
-
#
|
4634
|
+
# @param Agent: 代理企业和员工的信息。
|
4635
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4571
4636
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4572
|
-
# @param ContentType:
|
4573
|
-
|
4574
|
-
#
|
4637
|
+
# @param ContentType: 查询内容控制
|
4638
|
+
|
4639
|
+
# <ul><li>**0**:模板列表及详情(默认)</li>
|
4640
|
+
# <li>**1**:仅模板列表</li></ul>
|
4575
4641
|
# @type ContentType: Integer
|
4576
4642
|
# @param Filters: 搜索条件,本字段用于指定模板Id进行查询。
|
4577
|
-
# Key:template-id
|
4578
|
-
# Values:需要查询的模板Id列表
|
4643
|
+
# Key:template-id Values:需要查询的模板Id列表
|
4579
4644
|
# @type Filters: Array
|
4580
|
-
# @param Offset:
|
4645
|
+
# @param Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
|
4646
|
+
|
4647
|
+
# 注:`1.offset从0开始,即第一页为0。`
|
4648
|
+
# `2.默认从第一页返回。`
|
4581
4649
|
# @type Offset: Integer
|
4582
|
-
# @param Limit:
|
4650
|
+
# @param Limit: 指定每页返回的数据条数,和Offset参数配合使用。
|
4651
|
+
|
4652
|
+
# 注:`1.默认值为20,单页做大值为200。`
|
4583
4653
|
# @type Limit: Integer
|
4584
|
-
# @param ApplicationId:
|
4585
|
-
|
4586
|
-
# ApplicationId
|
4654
|
+
# @param ApplicationId: 指定查询的应用号,指定后查询该应用号下的模板列表。
|
4655
|
+
|
4656
|
+
# 注:`1.ApplicationId为空时,查询所有应用下的模板列表。`
|
4587
4657
|
# @type ApplicationId: String
|
4588
4658
|
# @param IsChannel: 默认为false,查询SaaS模板库列表;
|
4589
4659
|
# 为true,查询第三方应用集成平台企业模板库管理列表
|
@@ -4647,9 +4717,9 @@ module TencentCloud
|
|
4647
4717
|
|
4648
4718
|
# DescribeFlowTemplates返回参数结构体
|
4649
4719
|
class DescribeFlowTemplatesResponse < TencentCloud::Common::AbstractModel
|
4650
|
-
# @param Templates:
|
4720
|
+
# @param Templates: 模板详情列表数据
|
4651
4721
|
# @type Templates: Array
|
4652
|
-
# @param TotalCount:
|
4722
|
+
# @param TotalCount: 查询到的模板总数
|
4653
4723
|
# @type TotalCount: Integer
|
4654
4724
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
4655
4725
|
# @type RequestId: String
|
@@ -5050,36 +5120,46 @@ module TencentCloud
|
|
5050
5120
|
|
5051
5121
|
# DescribeOrganizationSeals请求参数结构体
|
5052
5122
|
class DescribeOrganizationSealsRequest < TencentCloud::Common::AbstractModel
|
5053
|
-
# @param Operator:
|
5123
|
+
# @param Operator: 执行本接口操作的员工信息。
|
5124
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
5054
5125
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
5055
|
-
# @param Limit:
|
5126
|
+
# @param Limit: 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。
|
5056
5127
|
# @type Limit: Integer
|
5057
|
-
# @param Offset:
|
5128
|
+
# @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000。
|
5058
5129
|
# @type Offset: Integer
|
5059
|
-
# @param InfoType:
|
5130
|
+
# @param InfoType: 查询信息类型,取值如下:
|
5131
|
+
# <ul>
|
5132
|
+
# <li>0不返回授权用户</li>
|
5133
|
+
# <li>1返回授权用户信息</li>
|
5134
|
+
# </ul>
|
5060
5135
|
# @type InfoType: Integer
|
5061
5136
|
# @param SealId: 印章id(没有输入返回所有)
|
5062
5137
|
# @type SealId: String
|
5063
5138
|
# @param SealTypes: 印章类型列表(都是组织机构印章)。
|
5064
5139
|
# 为空时查询所有类型的印章。
|
5065
5140
|
# 目前支持以下类型:
|
5066
|
-
#
|
5067
|
-
#
|
5068
|
-
#
|
5069
|
-
#
|
5141
|
+
# <ul>
|
5142
|
+
# <li>OFFICIAL:企业公章;</li>
|
5143
|
+
# <li>CONTRACT:合同专用章;</li>
|
5144
|
+
# <li>ORGANIZATION_SEAL:企业印章(图片上传创建);</li>
|
5145
|
+
# <li>LEGAL_PERSON_SEAL:法定代表人章</li>
|
5146
|
+
# </ul>
|
5070
5147
|
# @type SealTypes: Array
|
5071
|
-
# @param Agent:
|
5148
|
+
# @param Agent: 代理企业和员工的信息。
|
5149
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
5072
5150
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
5073
5151
|
# @param SealStatuses: 查询的印章状态列表。
|
5074
|
-
#
|
5075
|
-
#
|
5076
|
-
#
|
5077
|
-
#
|
5078
|
-
#
|
5079
|
-
#
|
5080
|
-
#
|
5081
|
-
#
|
5082
|
-
#
|
5152
|
+
# <ul>
|
5153
|
+
# <li>空,只查询启用状态的印章;</li>
|
5154
|
+
# <li>ALL,查询所有状态的印章;</li>
|
5155
|
+
# <li>CHECKING,查询待审核的印章;</li>
|
5156
|
+
# <li>SUCCESS,查询启用状态的印章;</li>
|
5157
|
+
# <li>FAIL,查询印章审核拒绝的印章;</li>
|
5158
|
+
# <li>DISABLE,查询已停用的印章;</li>
|
5159
|
+
# <li>STOPPED,查询已终止的印章;</li>
|
5160
|
+
# <li>VOID,查询已作废的印章;</li>
|
5161
|
+
# <li>INVALID,查询已失效的印章;</li>
|
5162
|
+
# </ul>
|
5083
5163
|
# @type SealStatuses: Array
|
5084
5164
|
|
5085
5165
|
attr_accessor :Operator, :Limit, :Offset, :InfoType, :SealId, :SealTypes, :Agent, :SealStatuses
|
@@ -6095,40 +6175,28 @@ module TencentCloud
|
|
6095
6175
|
|
6096
6176
|
# 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
|
6097
6177
|
class FlowDetailInfo < TencentCloud::Common::AbstractModel
|
6098
|
-
# @param FlowId:
|
6178
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
6099
6179
|
# @type FlowId: String
|
6100
|
-
# @param FlowName:
|
6180
|
+
# @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
6101
6181
|
# @type FlowName: String
|
6102
|
-
# @param FlowType:
|
6182
|
+
# @param FlowType: 合同流程的类别分类(如销售合同/入职合同等)。
|
6103
6183
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6104
6184
|
# @type FlowType: String
|
6105
|
-
# @param FlowStatus:
|
6106
|
-
# - 0 还没有发起
|
6107
|
-
# - 1 待签署
|
6108
|
-
# - 2 部分签署
|
6109
|
-
# - 3 已拒签
|
6110
|
-
# - 4 已签署
|
6111
|
-
# - 5 已过期
|
6112
|
-
# - 6 已撤销
|
6113
|
-
# - 7 还没有预发起
|
6114
|
-
# - 8 等待填写
|
6115
|
-
# - 9 部分填写
|
6116
|
-
# - 10 拒填
|
6117
|
-
# - 21 已解除
|
6185
|
+
# @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>
|
6118
6186
|
# @type FlowStatus: Integer
|
6119
|
-
# @param FlowMessage:
|
6187
|
+
# @param FlowMessage: 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
|
6120
6188
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6121
6189
|
# @type FlowMessage: String
|
6122
|
-
# @param FlowDescription:
|
6190
|
+
# @param FlowDescription: 合同流程描述信息。
|
6123
6191
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6124
6192
|
# @type FlowDescription: String
|
6125
|
-
# @param CreatedOn:
|
6193
|
+
# @param CreatedOn: 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
|
6126
6194
|
# @type CreatedOn: Integer
|
6127
|
-
# @param FlowApproverInfos:
|
6195
|
+
# @param FlowApproverInfos: 合同流程的签署方数组
|
6128
6196
|
# @type FlowApproverInfos: Array
|
6129
|
-
# @param CcInfos:
|
6197
|
+
# @param CcInfos: 合同流程的关注方信息数组
|
6130
6198
|
# @type CcInfos: Array
|
6131
|
-
# @param Creator:
|
6199
|
+
# @param Creator: 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
|
6132
6200
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6133
6201
|
# @type Creator: String
|
6134
6202
|
|
@@ -7358,11 +7426,13 @@ module TencentCloud
|
|
7358
7426
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
7359
7427
|
# @type RecipientId: String
|
7360
7428
|
# @param RecipientFillStatus: 参与方填写状态
|
7361
|
-
# 0
|
7362
|
-
# 1
|
7429
|
+
# <ul><li>0-未填写</li>
|
7430
|
+
# <li>1-已填写</li></ul>
|
7363
7431
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
7364
7432
|
# @type RecipientFillStatus: String
|
7365
7433
|
# @param IsPromoter: 是否为发起方
|
7434
|
+
# <ul><li>true-发起方</li>
|
7435
|
+
# <li>false-参与方</li></ul>
|
7366
7436
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
7367
7437
|
# @type IsPromoter: Boolean
|
7368
7438
|
# @param Components: 填写控件列表
|
@@ -8383,16 +8453,22 @@ module TencentCloud
|
|
8383
8453
|
|
8384
8454
|
# VerifyPdf请求参数结构体
|
8385
8455
|
class VerifyPdfRequest < TencentCloud::Common::AbstractModel
|
8386
|
-
# @param FlowId:
|
8456
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
8457
|
+
# 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
8387
8458
|
# @type FlowId: String
|
8388
|
-
# @param Operator:
|
8459
|
+
# @param Operator: 执行本接口操作的员工信息。
|
8460
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
8389
8461
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
8462
|
+
# @param Agent: 代理企业和员工的信息。
|
8463
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
8464
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
8390
8465
|
|
8391
|
-
attr_accessor :FlowId, :Operator
|
8466
|
+
attr_accessor :FlowId, :Operator, :Agent
|
8392
8467
|
|
8393
|
-
def initialize(flowid=nil, operator=nil)
|
8468
|
+
def initialize(flowid=nil, operator=nil, agent=nil)
|
8394
8469
|
@FlowId = flowid
|
8395
8470
|
@Operator = operator
|
8471
|
+
@Agent = agent
|
8396
8472
|
end
|
8397
8473
|
|
8398
8474
|
def deserialize(params)
|
@@ -8401,16 +8477,31 @@ module TencentCloud
|
|
8401
8477
|
@Operator = UserInfo.new
|
8402
8478
|
@Operator.deserialize(params['Operator'])
|
8403
8479
|
end
|
8480
|
+
unless params['Agent'].nil?
|
8481
|
+
@Agent = Agent.new
|
8482
|
+
@Agent.deserialize(params['Agent'])
|
8483
|
+
end
|
8404
8484
|
end
|
8405
8485
|
end
|
8406
8486
|
|
8407
8487
|
# VerifyPdf返回参数结构体
|
8408
8488
|
class VerifyPdfResponse < TencentCloud::Common::AbstractModel
|
8409
|
-
# @param VerifyResult:
|
8489
|
+
# @param VerifyResult: 验签结果代码,代码的含义如下:
|
8490
|
+
|
8491
|
+
# <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
|
8492
|
+
# <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
|
8493
|
+
# <li>**3**:文件被篡改。</li>
|
8494
|
+
# <li>**4**:异常:文件内没有签名域。</li>
|
8495
|
+
# <li>**5**:异常:文件签名格式错误。</li></ul>
|
8410
8496
|
# @type VerifyResult: Integer
|
8411
|
-
# @param PdfVerifyResults:
|
8497
|
+
# @param PdfVerifyResults: 验签结果详情,每个签名域对应的验签结果。状态值如下
|
8498
|
+
# <ul><li> **1** :验签成功,在电子签签署</li>
|
8499
|
+
# <li> **2** :验签成功,在其他平台签署</li>
|
8500
|
+
# <li> **3** :验签失败</li>
|
8501
|
+
# <li> **4** :pdf文件没有签名域</li>
|
8502
|
+
# <li> **5** :文件签名格式错误</li></ul>
|
8412
8503
|
# @type PdfVerifyResults: Array
|
8413
|
-
# @param VerifySerialNo:
|
8504
|
+
# @param VerifySerialNo: 验签序列号, 为11为数组组成的字符串
|
8414
8505
|
# @type VerifySerialNo: String
|
8415
8506
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
8416
8507
|
# @type RequestId: String
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tencentcloud-sdk-ess
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.663
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tencent Cloud
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-09-
|
11
|
+
date: 2023-09-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|