tencentcloud-sdk-essbasic 3.0.693 → 3.0.694

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 92122df741bad1ea9f788e2ae1cb6c6472745879
4
- data.tar.gz: f1efbb685b40827eae5b25856dd6f19c29255d6c
3
+ metadata.gz: f03e4987042c0a918a16d1893c49fa5be52603dc
4
+ data.tar.gz: 9f079cce878c38fa3f08190c4244418b02d9f0c2
5
5
  SHA512:
6
- metadata.gz: e88a6ba347e69dcab1080753b7365246212eaadf481b5a52c45da80dd59527dcd02116ea56bafeede50a84493462eab74d2a85e1bd4fd536773c2dd854eb0341
7
- data.tar.gz: 8f834d517c5955c554e08b3c315cee2678978c53d9c7429ec94136c06ac3e4a8de59fd4b3ac69f0e8fa1d214b895cba7fa8c3638ec9546899cd9a3b04b6c15d3
6
+ metadata.gz: 25e95c4ff85e82970488b1311ac7582a2f18d1249b7c14fad9252f077bb2dafe0f65b4b8afb06ec4c63cee40408bd3d7a231d11d6d5e0c3cb1cf2dc680548d12
7
+ data.tar.gz: 7f6f779ea99c5cc432d1a216370e57a5757c3613240bd85944fff6aa9acf43efe519f1c0be12e38b46af3fab01f85d6b9a377e91a24acbdd2dc5087265bc0119
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.693
1
+ 3.0.694
@@ -653,10 +653,14 @@ module TencentCloud
653
653
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
654
654
  end
655
655
 
656
- # 该接口用于发起合同后,生成C端签署人的签署链接<br/>
657
- # 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
658
- # 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
659
- # 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
656
+ # 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
657
+
658
+ # `注意:`<br/>
659
+ # `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
660
+ # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
661
+ # `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
662
+ # `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
663
+ # 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
660
664
 
661
665
  # @param request: Request instance for ChannelCreateFlowSignUrl.
662
666
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`
@@ -1351,12 +1355,13 @@ module TencentCloud
1351
1355
  # 提交申请出证报告任务并返回报告ID。
1352
1356
 
1353
1357
  # 注意:
1354
- # <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
1355
- # <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
1356
- # <li>合同流程必须所有参与方`已经签署完成`。</li>
1357
- # <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
1358
+ # - 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
1359
+ # - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
1360
+ # - 合同流程必须**所有参与方已经签署完成**。
1361
+ # - 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL
1358
1362
 
1359
- # <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>
1363
+
1364
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
1360
1365
 
1361
1366
  # @param request: Request instance for CreateChannelFlowEvidenceReport.
1362
1367
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateChannelFlowEvidenceReportRequest`
@@ -1639,7 +1644,14 @@ module TencentCloud
1639
1644
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1640
1645
  end
1641
1646
 
1642
- # 查询出证报告,返回报告 URL。
1647
+ # 获取出证报告任务执行结果,返回报告 URL。
1648
+
1649
+ # 注意:
1650
+
1651
+ # - 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
1652
+ # - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
1653
+
1654
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
1643
1655
 
1644
1656
  # @param request: Request instance for DescribeChannelFlowEvidenceReport.
1645
1657
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeChannelFlowEvidenceReportRequest`
@@ -1767,6 +1779,8 @@ module TencentCloud
1767
1779
  # - 发起方和签署方的填写控件 Components
1768
1780
  # - 签署方的签署控件 SignComponents
1769
1781
 
1782
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
1783
+
1770
1784
  # **适用场景**
1771
1785
  # 该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
1772
1786
  # 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
@@ -460,6 +460,8 @@ module TencentCloud
460
460
  # ChannelBatchCancelFlows返回参数结构体
461
461
  class ChannelBatchCancelFlowsResponse < TencentCloud::Common::AbstractModel
462
462
  # @param FailMessages: 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
463
+
464
+ # 注: `如果全部撤销成功, 此数组为空数组`
463
465
  # @type FailMessages: Array
464
466
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
465
467
  # @type RequestId: String
@@ -1741,17 +1743,30 @@ module TencentCloud
1741
1743
 
1742
1744
  # ChannelCreateFlowSignUrl请求参数结构体
1743
1745
  class ChannelCreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
1744
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
1746
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1747
+
1748
+ # 此接口下面信息必填。
1749
+ # <ul>
1750
+ # <li>渠道应用标识: Agent.AppId</li>
1751
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1752
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1753
+ # </ul>
1754
+ # 第三方平台子客企业和员工必须已经经过实名认证
1745
1755
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1746
- # @param FlowId: 流程编号
1756
+ # @param FlowId: 合同流程ID,为32位字符串。
1757
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1758
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1747
1759
  # @type FlowId: String
1748
- # @param FlowApproverInfos: 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
1760
+ # @param FlowApproverInfos: 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。
1761
+ # 注:
1762
+ # `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
1763
+ # `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
1749
1764
  # @type FlowApproverInfos: Array
1750
1765
  # @param Operator: 用户信息,暂未开放
1751
1766
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
1752
1767
  # @param Organization: 机构信息,暂未开放
1753
1768
  # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
1754
- # @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
1769
+ # @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
1755
1770
  # @type JumpUrl: String
1756
1771
 
1757
1772
  attr_accessor :Agent, :FlowId, :FlowApproverInfos, :Operator, :Organization, :JumpUrl
@@ -2363,7 +2378,7 @@ module TencentCloud
2363
2378
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2364
2379
  # @param Description: 角色描述,最大长度为50个字符
2365
2380
  # @type Description: String
2366
- # @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
2381
+ # @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
2367
2382
  # @type PermissionGroups: Array
2368
2383
 
2369
2384
  attr_accessor :Name, :Agent, :Description, :PermissionGroups
@@ -3518,7 +3533,7 @@ module TencentCloud
3518
3533
  # @type RoleId: String
3519
3534
  # @param Description: 角色描述,最大长度为50个字符
3520
3535
  # @type Description: String
3521
- # @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
3536
+ # @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
3522
3537
  # @type PermissionGroups: Array
3523
3538
 
3524
3539
  attr_accessor :Agent, :Name, :RoleId, :Description, :PermissionGroups
@@ -3669,10 +3684,16 @@ module TencentCloud
3669
3684
  # ChannelVerifyPdf请求参数结构体
3670
3685
  class ChannelVerifyPdfRequest < TencentCloud::Common::AbstractModel
3671
3686
  # @param FlowId: 合同流程ID,为32位字符串。
3672
- # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3673
3687
  # @type FlowId: String
3674
- # @param Agent: 代理企业和员工的信息。
3675
- # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3688
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3689
+
3690
+ # 此接口下面信息必填。
3691
+ # <ul>
3692
+ # <li>渠道应用标识: Agent.AppId</li>
3693
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3694
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3695
+ # </ul>
3696
+ # 第三方平台子客企业和员工必须已经经过实名认证
3676
3697
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3677
3698
  # @param Operator: 暂未开放
3678
3699
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -3708,15 +3729,10 @@ module TencentCloud
3708
3729
  # <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
3709
3730
  # <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
3710
3731
  # <li>**3**:文件被篡改。</li>
3711
- # <li>**4**:异常:文件内没有签名域。</li>
3732
+ # <li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
3712
3733
  # <li>**5**:异常:文件签名格式错误。</li></ul>
3713
3734
  # @type VerifyResult: Integer
3714
- # @param PdfVerifyResults: 验签结果详情,每个签名域对应的验签结果。状态值如下
3715
- # <ul><li> **1** :验签成功,在电子签签署</li>
3716
- # <li> **2** :验签成功,在其他平台签署</li>
3717
- # <li> **3** :验签失败</li>
3718
- # <li> **4** :pdf文件没有签名域</li>
3719
- # <li> **5** :文件签名格式错误</li></ul>
3735
+ # @param PdfVerifyResults: 验签结果详情,所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
3720
3736
  # @type PdfVerifyResults: Array
3721
3737
  # @param VerifySerialNo: 验签序列号, 为11为数组组成的字符串
3722
3738
  # @type VerifySerialNo: String
@@ -4187,14 +4203,15 @@ module TencentCloud
4187
4203
 
4188
4204
  # CreateChannelFlowEvidenceReport请求参数结构体
4189
4205
  class CreateChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
4190
- # @param Agent: 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4206
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4191
4207
 
4192
4208
  # 此接口下面信息必填。
4193
4209
  # <ul>
4194
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4195
- # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4196
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4210
+ # <li>渠道应用标识: Agent.AppId</li>
4211
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4212
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4197
4213
  # </ul>
4214
+ # 第三方平台子客企业和员工必须已经经过实名认证
4198
4215
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4199
4216
  # @param FlowId: 合同流程ID,为32位字符串。
4200
4217
  # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
@@ -4913,9 +4930,17 @@ module TencentCloud
4913
4930
 
4914
4931
  # DescribeChannelFlowEvidenceReport请求参数结构体
4915
4932
  class DescribeChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
4916
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4933
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4934
+
4935
+ # 此接口下面信息必填。
4936
+ # <ul>
4937
+ # <li>渠道应用标识: Agent.AppId</li>
4938
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4939
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4940
+ # </ul>
4941
+ # 第三方平台子客企业和员工必须已经经过实名认证
4917
4942
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4918
- # @param ReportId: 出证报告编号
4943
+ # @param ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
4919
4944
  # @type ReportId: String
4920
4945
  # @param Operator: 暂未开放
4921
4946
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -4946,14 +4971,14 @@ module TencentCloud
4946
4971
 
4947
4972
  # DescribeChannelFlowEvidenceReport返回参数结构体
4948
4973
  class DescribeChannelFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
4949
- # @param ReportUrl: 出证报告下载 URL
4974
+ # @param ReportUrl: 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
4950
4975
  # 注意:此字段可能返回 null,表示取不到有效值。
4951
4976
  # @type ReportUrl: String
4952
- # @param Status: 出征任务的执行状态,状态列表如下
4977
+ # @param Status: 出证任务执行的状态, 状态含义如下:
4953
4978
 
4954
- # - EvidenceStatusExecuting : 出征任务正在执行中
4955
- # - EvidenceStatusSuccess : 出征任务执行成功
4956
- # - EvidenceStatusFailed : 出征任务执行失败
4979
+ # <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
4980
+ # <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
4981
+ # <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
4957
4982
  # @type Status: String
4958
4983
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4959
4984
  # @type RequestId: String
@@ -5992,17 +6017,24 @@ module TencentCloud
5992
6017
  end
5993
6018
  end
5994
6019
 
5995
- # 签署人签署链接信息
6020
+ # 签署人签署链接信息。
5996
6021
  class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
5997
- # @param SignUrl: 签署短链接,不支持小程序嵌入,只支持移动端浏览器打开。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
6022
+ # @param SignUrl: 签署短链接。</br>
6023
+ # 注意:
6024
+ # - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
6025
+ # - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
5998
6026
  # @type SignUrl: String
5999
- # @param ApproverType: 签署人类型 PERSON-个人
6027
+ # @param ApproverType: 签署人类型。
6028
+ # - **PERSON**: 个人
6000
6029
  # @type ApproverType: String
6001
- # @param Name: 签署人姓名
6030
+ # @param Name: 签署人姓名。
6002
6031
  # @type Name: String
6003
- # @param Mobile: 签署人手机号
6032
+ # @param Mobile: 签署人手机号。
6004
6033
  # @type Mobile: String
6005
- # @param LongUrl: 签署长链接,支持小程序嵌入。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
6034
+ # @param LongUrl: 签署长链接。</br>
6035
+ # 注意:
6036
+ # - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
6037
+ # - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
6006
6038
  # 注意:此字段可能返回 null,表示取不到有效值。
6007
6039
  # @type LongUrl: String
6008
6040
 
@@ -7074,25 +7106,41 @@ module TencentCloud
7074
7106
  end
7075
7107
  end
7076
7108
 
7077
- # 合同文件验签单个结果结构体
7109
+ # 合同验签每个签署区的信息
7078
7110
  class PdfVerifyResult < TencentCloud::Common::AbstractModel
7079
- # @param VerifyResult: 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
7111
+ # @param VerifyResult: 验签结果详情,每个签名域对应的验签结果。状态值如下
7112
+ # <ul><li> **1** :验签成功,在电子签签署</li>
7113
+ # <li> **2** :验签成功,在其他平台签署</li>
7114
+ # <li> **3** :验签失败</li>
7115
+ # <li> **4** :pdf文件没有签名域</li>
7116
+ # <li> **5** :文件签名格式错误</li></ul>
7080
7117
  # @type VerifyResult: Integer
7081
- # @param SignPlatform: 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
7118
+ # @param SignPlatform: 签署平台
7119
+ # 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
7120
+ # 如果文件不在腾讯电子签平台签署,则为**其他平台**。
7082
7121
  # @type SignPlatform: String
7083
- # @param SignerName: 签署人名称
7122
+ # @param SignerName: 申请证书的主体的名字
7123
+
7124
+ # 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
7125
+ # **企业**: ESS@企业名称@编码
7126
+ # **个人**: ESS@个人姓名@证件号@808854
7127
+
7128
+ # 如果在其他平台签署的, 主体的名字参考其他平台的说明
7084
7129
  # @type SignerName: String
7085
- # @param SignTime: 签署时间戳,单位秒
7130
+ # @param SignTime: 签署时间的Unix时间戳,单位毫秒
7086
7131
  # @type SignTime: Integer
7087
- # @param SignAlgorithm: 签名算法
7132
+ # @param SignAlgorithm: 证书签名算法, 如SHA1withRSA等算法
7088
7133
  # @type SignAlgorithm: String
7089
- # @param CertSn: 签名证书序列号
7134
+ # @param CertSn: CA供应商下发给用户的证书编号
7135
+
7136
+ # 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
7090
7137
  # @type CertSn: String
7091
- # @param CertNotBefore: 证书起始时间戳,单位秒
7138
+ # @param CertNotBefore: 证书起始时间的Unix时间戳,单位毫秒
7092
7139
  # @type CertNotBefore: Integer
7093
- # @param CertNotAfter: 证书过期时间戳,单位秒
7140
+ # @param CertNotAfter: 证书过期时间的时间戳,单位毫秒
7094
7141
  # @type CertNotAfter: Integer
7095
- # @param SignType: 签名类型
7142
+ # @param SignType: 签名类型, 保留字段, 现在全部为0
7143
+
7096
7144
  # @type SignType: Integer
7097
7145
  # @param ComponentPosX: 签名域横坐标,单位px
7098
7146
  # @type ComponentPosX: Float
@@ -7329,7 +7377,7 @@ module TencentCloud
7329
7377
  # @param IdCardType: 签署方经办人的证件类型,支持以下类型
7330
7378
  # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
7331
7379
  # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
7332
- # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
7380
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
7333
7381
  # @type IdCardType: String
7334
7382
  # @param IdCardNumber: 经办人证件号
7335
7383
  # @type IdCardNumber: String
@@ -7480,7 +7528,7 @@ module TencentCloud
7480
7528
  # @param IdCardType: 签署方经办人的证件类型,支持以下类型
7481
7529
  # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
7482
7530
  # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
7483
- # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
7531
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
7484
7532
  # @type IdCardType: String
7485
7533
  # @param IdCardNumber: 证件号码,应符合以下规则
7486
7534
  # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.693
4
+ version: 3.0.694
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-11-05 00:00:00.000000000 Z
11
+ date: 2023-11-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common