tencentcloud-sdk-ess 3.0.658 → 3.0.659
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.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +26 -9
- data/lib/v20201111/models.rb +92 -54
- 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: efc4c0633580ab9b74dbd7f13cd53b701ff8ea6f
|
|
4
|
+
data.tar.gz: 9f433efe62a9562e0bcb92a387f90be00227e524
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7626bc5059f0a2f9905e7f31d36a76252718c3e4a2f4bdcdfb71ba376286f6f5e3266c011f40a64699ec5b801841270d8443693a1e23adee0ca789e59b18dc1d
|
|
7
|
+
data.tar.gz: c2825ba3fdd0513c9ba379632138183e793d6a9131cc9217674f500de494691e04221ce23b3383a08fa43018458f7cf944bdb06945d5283668bda785f5ff2b5c
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.659
|
data/lib/v20201111/client.rb
CHANGED
|
@@ -327,9 +327,15 @@ module TencentCloud
|
|
|
327
327
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
328
328
|
end
|
|
329
329
|
|
|
330
|
-
#
|
|
331
|
-
|
|
332
|
-
#
|
|
330
|
+
# 提交申请出证报告任务并返回报告ID。
|
|
331
|
+
|
|
332
|
+
# 注意:
|
|
333
|
+
# <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
|
|
334
|
+
# <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
|
|
335
|
+
# <li>合同流程必须所有参与方`已经签署完成`。</li>
|
|
336
|
+
# <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
|
|
337
|
+
|
|
338
|
+
# <svg id="SvgjsSvg1006" width="262" height="229" 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="SvgjsDefs1007"><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="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
|
|
333
339
|
|
|
334
340
|
# @param request: Request instance for CreateFlowEvidenceReport.
|
|
335
341
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowEvidenceReportRequest`
|
|
@@ -353,9 +359,11 @@ module TencentCloud
|
|
|
353
359
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
354
360
|
end
|
|
355
361
|
|
|
356
|
-
# 此接口(CreateFlowGroupByFiles
|
|
357
|
-
|
|
358
|
-
#
|
|
362
|
+
# 此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。
|
|
363
|
+
|
|
364
|
+
# 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
|
|
365
|
+
|
|
366
|
+
# 注意事项:使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
|
|
359
367
|
|
|
360
368
|
# @param request: Request instance for CreateFlowGroupByFiles.
|
|
361
369
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowGroupByFilesRequest`
|
|
@@ -635,7 +643,7 @@ module TencentCloud
|
|
|
635
643
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
636
644
|
end
|
|
637
645
|
|
|
638
|
-
#
|
|
646
|
+
# 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
|
|
639
647
|
# 附注:
|
|
640
648
|
# - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方。
|
|
641
649
|
# - 如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
|
|
@@ -888,7 +896,8 @@ module TencentCloud
|
|
|
888
896
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
889
897
|
end
|
|
890
898
|
|
|
891
|
-
#
|
|
899
|
+
# 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
|
|
900
|
+
# 创建配置对当前企业全局生效,如果多次调用,会以最后一次的配置为准
|
|
892
901
|
|
|
893
902
|
# @param request: Request instance for CreateWebThemeConfig.
|
|
894
903
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateWebThemeConfigRequest`
|
|
@@ -1116,7 +1125,15 @@ module TencentCloud
|
|
|
1116
1125
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
1117
1126
|
end
|
|
1118
1127
|
|
|
1119
|
-
#
|
|
1128
|
+
# 获取出证报告任务执行结果,返回报告 URL。
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
# 注意:
|
|
1133
|
+
# <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
|
|
1134
|
+
# <li>需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。</li></ul>
|
|
1135
|
+
|
|
1136
|
+
# <svg id="SvgjsSvg1006" width="262" height="229" 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="SvgjsDefs1007"><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="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
|
|
1120
1137
|
|
|
1121
1138
|
# @param request: Request instance for DescribeFlowEvidenceReport.
|
|
1122
1139
|
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportRequest`
|
data/lib/v20201111/models.rb
CHANGED
|
@@ -343,7 +343,7 @@ module TencentCloud
|
|
|
343
343
|
# @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
344
344
|
|
|
345
345
|
# <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
346
|
-
#
|
|
346
|
+
# </ul>
|
|
347
347
|
# @type LicenseType: Integer
|
|
348
348
|
|
|
349
349
|
attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType
|
|
@@ -1631,14 +1631,14 @@ module TencentCloud
|
|
|
1631
1631
|
|
|
1632
1632
|
# CreateFlowEvidenceReport返回参数结构体
|
|
1633
1633
|
class CreateFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
|
|
1634
|
-
# @param ReportId: 出证报告 ID
|
|
1634
|
+
# @param ReportId: 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
|
|
1635
1635
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
|
1636
1636
|
# @type ReportId: String
|
|
1637
|
-
# @param Status: 出证任务执行的状态,
|
|
1637
|
+
# @param Status: 出证任务执行的状态, 状态含义如下:
|
|
1638
1638
|
|
|
1639
|
-
# <ul><li
|
|
1640
|
-
# <li
|
|
1641
|
-
# <li
|
|
1639
|
+
# <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
|
|
1640
|
+
# <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
|
|
1641
|
+
# <li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
|
|
1642
1642
|
# @type Status: String
|
|
1643
1643
|
# @param ReportUrl: 此字段已经废除,不再使用.
|
|
1644
1644
|
# 出证的PDF下载地址请调用DescribeChannelFlowEvidenceReport接口获取
|
|
@@ -1669,15 +1669,22 @@ module TencentCloud
|
|
|
1669
1669
|
|
|
1670
1670
|
# CreateFlowGroupByFiles请求参数结构体
|
|
1671
1671
|
class CreateFlowGroupByFilesRequest < TencentCloud::Common::AbstractModel
|
|
1672
|
-
# @param Operator:
|
|
1672
|
+
# @param Operator: 执行本接口操作的员工信息。
|
|
1673
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
1673
1674
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
|
1674
|
-
# @param FlowGroupName:
|
|
1675
|
+
# @param FlowGroupName: 合同(流程)组名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
1675
1676
|
# @type FlowGroupName: String
|
|
1676
1677
|
# @param FlowGroupInfos: 合同(流程)组的子合同信息,支持2-50个子合同
|
|
1677
1678
|
# @type FlowGroupInfos: Array
|
|
1678
|
-
# @param Agent:
|
|
1679
|
+
# @param Agent: 代理企业和员工的信息。
|
|
1680
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
1679
1681
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
|
1680
|
-
# @param FlowGroupOptions:
|
|
1682
|
+
# @param FlowGroupOptions: 合同(流程)组的配置项信息。
|
|
1683
|
+
# 其中包括:
|
|
1684
|
+
# <ul>
|
|
1685
|
+
# <li>是否通知本企业签署方</li>
|
|
1686
|
+
# <li>是否通知其他签署方</li>
|
|
1687
|
+
# </ul>
|
|
1681
1688
|
# @type FlowGroupOptions: :class:`Tencentcloud::Ess.v20201111.models.FlowGroupOptions`
|
|
1682
1689
|
|
|
1683
1690
|
attr_accessor :Operator, :FlowGroupName, :FlowGroupInfos, :Agent, :FlowGroupOptions
|
|
@@ -2672,22 +2679,24 @@ module TencentCloud
|
|
|
2672
2679
|
|
|
2673
2680
|
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
2674
2681
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
|
2675
|
-
# @param FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100
|
|
2676
|
-
# 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID
|
|
2682
|
+
# @param FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。
|
|
2683
|
+
# 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。
|
|
2677
2684
|
# 用户将利用链接对这些合同实施批量操作。
|
|
2678
2685
|
# @type FlowIds: Array
|
|
2679
2686
|
# @param Agent: 代理企业和员工的信息。
|
|
2680
2687
|
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
2681
2688
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
|
2682
|
-
# @param UserId: 员工在腾讯电子签平台的独特身份标识,为32
|
|
2683
|
-
# 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID
|
|
2689
|
+
# @param UserId: 员工在腾讯电子签平台的独特身份标识,为32位字符串。
|
|
2690
|
+
# 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
|
|
2684
2691
|
# UserId必须是传入合同(FlowId)中的签署人。
|
|
2685
2692
|
# - 1. 若UserId为空,Name和Mobile 必须提供。
|
|
2686
2693
|
# - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
|
|
2687
2694
|
# @type UserId: String
|
|
2688
|
-
# @param Name:
|
|
2695
|
+
# @param Name: 员工姓名,必须与手机号码一起使用。
|
|
2696
|
+
# 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
|
|
2689
2697
|
# @type Name: String
|
|
2690
|
-
# @param Mobile:
|
|
2698
|
+
# @param Mobile: 员工手机号,必须与姓名一起使用。
|
|
2699
|
+
# 如果UserId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
|
|
2691
2700
|
# @type Mobile: String
|
|
2692
2701
|
|
|
2693
2702
|
attr_accessor :Operator, :FlowIds, :Agent, :UserId, :Name, :Mobile
|
|
@@ -3632,15 +3641,16 @@ module TencentCloud
|
|
|
3632
3641
|
|
|
3633
3642
|
# CreateWebThemeConfig请求参数结构体
|
|
3634
3643
|
class CreateWebThemeConfigRequest < TencentCloud::Common::AbstractModel
|
|
3635
|
-
# @param Operator:
|
|
3644
|
+
# @param Operator: 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3636
3645
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
|
3637
|
-
# @param ThemeType:
|
|
3638
|
-
# <
|
|
3639
|
-
#
|
|
3646
|
+
# @param ThemeType: 主题类型,取值如下:
|
|
3647
|
+
# <ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
|
|
3648
|
+
# </ul>
|
|
3640
3649
|
# @type ThemeType: String
|
|
3641
3650
|
# @param WebThemeConfig: 主题配置
|
|
3642
3651
|
# @type WebThemeConfig: :class:`Tencentcloud::Ess.v20201111.models.WebThemeConfig`
|
|
3643
|
-
# @param Agent: 代理企业和员工的信息。
|
|
3652
|
+
# @param Agent: 代理企业和员工的信息。
|
|
3653
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3644
3654
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
|
3645
3655
|
|
|
3646
3656
|
attr_accessor :Operator, :ThemeType, :WebThemeConfig, :Agent
|
|
@@ -4265,7 +4275,7 @@ module TencentCloud
|
|
|
4265
4275
|
# @param Operator: 执行本接口操作的员工信息。
|
|
4266
4276
|
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4267
4277
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
|
4268
|
-
# @param ReportId:
|
|
4278
|
+
# @param ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
|
|
4269
4279
|
# @type ReportId: String
|
|
4270
4280
|
# @param Agent: 代理企业和员工的信息。
|
|
4271
4281
|
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
@@ -4294,15 +4304,14 @@ module TencentCloud
|
|
|
4294
4304
|
|
|
4295
4305
|
# DescribeFlowEvidenceReport返回参数结构体
|
|
4296
4306
|
class DescribeFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
|
|
4297
|
-
# @param ReportUrl: 出证报告PDF的下载 URL
|
|
4307
|
+
# @param ReportUrl: 出证报告PDF的下载 URL,`有效期为5分钟`,超过有效期后将无法再下载。
|
|
4298
4308
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
|
4299
4309
|
# @type ReportUrl: String
|
|
4300
|
-
# @param Status:
|
|
4301
|
-
|
|
4302
|
-
# <li
|
|
4303
|
-
# <li
|
|
4304
|
-
# <li
|
|
4305
|
-
# </ul>
|
|
4310
|
+
# @param Status: 出证任务执行的状态, 状态含义如下:
|
|
4311
|
+
|
|
4312
|
+
# <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
|
|
4313
|
+
# <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
|
|
4314
|
+
# <li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
|
|
4306
4315
|
# @type Status: String
|
|
4307
4316
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4308
4317
|
# @type RequestId: String
|
|
@@ -5103,8 +5112,7 @@ module TencentCloud
|
|
|
5103
5112
|
# @type LicenseTo: Integer
|
|
5104
5113
|
# @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
5105
5114
|
|
|
5106
|
-
# <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
5107
|
-
# <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
|
5115
|
+
# <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
|
|
5108
5116
|
# @type LicenseType: Integer
|
|
5109
5117
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5110
5118
|
# @type RequestId: String
|
|
@@ -6021,34 +6029,63 @@ module TencentCloud
|
|
|
6021
6029
|
|
|
6022
6030
|
# 此结构体(FlowGroupInfo)描述的是合同组(流程组)的单个合同(流程)信息
|
|
6023
6031
|
class FlowGroupInfo < TencentCloud::Common::AbstractModel
|
|
6024
|
-
# @param FlowName:
|
|
6032
|
+
# @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
6033
|
+
# 该名称还将用于合同签署完成后的下载文件名。
|
|
6025
6034
|
# @type FlowName: String
|
|
6026
|
-
# @param Approvers:
|
|
6035
|
+
# @param Approvers: 签署流程参与者信息,最大限制50方
|
|
6036
|
+
# 注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
|
|
6027
6037
|
# @type Approvers: Array
|
|
6028
|
-
# @param FileIds:
|
|
6038
|
+
# @param FileIds: 文件资源ID,通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得,为32位字符串。
|
|
6039
|
+
# 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
|
|
6029
6040
|
# @type FileIds: Array
|
|
6030
|
-
# @param TemplateId:
|
|
6041
|
+
# @param TemplateId: 合同模板ID,为32位字符串。
|
|
6042
|
+
# 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
6043
|
+
# 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
|
6031
6044
|
# @type TemplateId: String
|
|
6032
|
-
# @param FlowType:
|
|
6045
|
+
# @param FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
|
|
6046
|
+
# 示例值:劳务合同
|
|
6033
6047
|
# @type FlowType: String
|
|
6034
|
-
# @param FlowDescription:
|
|
6048
|
+
# @param FlowDescription: 签署流程描述,最大长度1000个字符
|
|
6035
6049
|
# @type FlowDescription: String
|
|
6036
|
-
# @param Deadline:
|
|
6050
|
+
# @param Deadline: 签署流程的签署截止时间。
|
|
6051
|
+
|
|
6052
|
+
# 值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
6053
|
+
# 示例值:1604912664
|
|
6037
6054
|
# @type Deadline: Integer
|
|
6038
6055
|
# @param CallbackUrl: 合同(流程)的回调地址
|
|
6039
6056
|
# @type CallbackUrl: String
|
|
6040
|
-
# @param UserData:
|
|
6057
|
+
# @param UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
6058
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
6059
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
6041
6060
|
# @type UserData: String
|
|
6042
|
-
# @param Unordered:
|
|
6061
|
+
# @param Unordered: 发送类型:
|
|
6062
|
+
# true:无序签
|
|
6063
|
+
# false:有序签
|
|
6064
|
+
# 注:默认为false(有序签),请和模板中的配置保持一致
|
|
6065
|
+
# 示例值:true
|
|
6043
6066
|
# @type Unordered: Boolean
|
|
6044
|
-
# @param Components:
|
|
6067
|
+
# @param Components: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
6068
|
+
# <ul><li>单行文本控件</li>
|
|
6069
|
+
# <li>多行文本控件</li>
|
|
6070
|
+
# <li>勾选框控件</li>
|
|
6071
|
+
# <li>数字控件</li>
|
|
6072
|
+
# <li>图片控件</li>
|
|
6073
|
+
# <li>动态表格等填写控件</li></ul>
|
|
6045
6074
|
# @type Components: Array
|
|
6046
|
-
# @param NeedSignReview:
|
|
6075
|
+
# @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
|
|
6076
|
+
# 若设置为true,审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
|
|
6077
|
+
|
|
6078
|
+
# 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
|
|
6079
|
+
# 示例值:true
|
|
6047
6080
|
# @type NeedSignReview: Boolean
|
|
6048
|
-
# @param AutoSignScene:
|
|
6081
|
+
# @param AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
6082
|
+
# 示例值:E_PRESCRIPTION_AUTO_SIGN
|
|
6049
6083
|
# @type AutoSignScene: String
|
|
6050
6084
|
|
|
6051
6085
|
attr_accessor :FlowName, :Approvers, :FileIds, :TemplateId, :FlowType, :FlowDescription, :Deadline, :CallbackUrl, :UserData, :Unordered, :Components, :NeedSignReview, :AutoSignScene
|
|
6086
|
+
extend Gem::Deprecate
|
|
6087
|
+
deprecate :CallbackUrl, :none, 2023, 9
|
|
6088
|
+
deprecate :CallbackUrl=, :none, 2023, 9
|
|
6052
6089
|
|
|
6053
6090
|
def initialize(flowname=nil, approvers=nil, fileids=nil, templateid=nil, flowtype=nil, flowdescription=nil, deadline=nil, callbackurl=nil, userdata=nil, unordered=nil, components=nil, needsignreview=nil, autosignscene=nil)
|
|
6054
6091
|
@FlowName = flowname
|
|
@@ -6099,16 +6136,18 @@ module TencentCloud
|
|
|
6099
6136
|
|
|
6100
6137
|
# 此结构体(FlowGroupOptions)描述的是合同组的个性化配置,支持控制是否发送短信、未实名个人签署方查看合同组时是否需要实名认证(仅在合同组文件发起配置时生效)
|
|
6101
6138
|
class FlowGroupOptions < TencentCloud::Common::AbstractModel
|
|
6102
|
-
# @param ApproverVerifyType:
|
|
6103
|
-
# VerifyCheck:
|
|
6104
|
-
# MobileCheck
|
|
6139
|
+
# @param ApproverVerifyType: 签署人校验方式,支持以下类型
|
|
6140
|
+
# <ul><li>VerifyCheck : 人脸识别 (默认值)</li>
|
|
6141
|
+
# <li>MobileCheck : 手机号验证</li></ul>
|
|
6105
6142
|
# 参数说明:此参数仅在合同组文件发起有效,可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
6106
6143
|
# @type ApproverVerifyType: String
|
|
6107
6144
|
# @param SelfOrganizationApproverNotifyType: 发起合同(流程)组本方企业经办人通知方式
|
|
6108
|
-
#
|
|
6145
|
+
# 签署通知类型,支持以下类型
|
|
6146
|
+
# <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
|
|
6109
6147
|
# @type SelfOrganizationApproverNotifyType: String
|
|
6110
6148
|
# @param OtherApproverNotifyType: 发起合同(流程)组他方经办人通知方式
|
|
6111
|
-
#
|
|
6149
|
+
# 签署通知类型,支持以下类型
|
|
6150
|
+
# <ul><li>sms : 短信 (默认值)</li><li>none : 不通知</li></ul>
|
|
6112
6151
|
# @type OtherApproverNotifyType: String
|
|
6113
6152
|
|
|
6114
6153
|
attr_accessor :ApproverVerifyType, :SelfOrganizationApproverNotifyType, :OtherApproverNotifyType
|
|
@@ -8262,13 +8301,12 @@ module TencentCloud
|
|
|
8262
8301
|
# 页面主题配置
|
|
8263
8302
|
class WebThemeConfig < TencentCloud::Common::AbstractModel
|
|
8264
8303
|
# @param DisplaySignBrandLogo: 是否显示页面底部电子签logo,取值如下:
|
|
8265
|
-
# <ul>
|
|
8266
|
-
# <li> **
|
|
8267
|
-
# <li> **false**:页面底部不显示电子签logo(默认)</li>
|
|
8268
|
-
# </ul>
|
|
8304
|
+
# <ul><li> **true**:页面底部显示电子签logo</li>
|
|
8305
|
+
# <li> **false**:页面底部不显示电子签logo(默认)</li></ul>
|
|
8269
8306
|
# @type DisplaySignBrandLogo: Boolean
|
|
8270
|
-
# @param WebEmbedThemeColor:
|
|
8271
|
-
#
|
|
8307
|
+
# @param WebEmbedThemeColor: 主题颜色:
|
|
8308
|
+
# 支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
|
|
8309
|
+
# <br/>
|
|
8272
8310
|
# @type WebEmbedThemeColor: String
|
|
8273
8311
|
|
|
8274
8312
|
attr_accessor :DisplaySignBrandLogo, :WebEmbedThemeColor
|
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.659
|
|
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-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|