tencentcloud-sdk-essbasic 3.0.693 → 3.0.695
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/v20210526/client.rb +43 -16
- data/lib/v20210526/models.rb +122 -57
- 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: 30a5ceb47a62b7f419bd84e3dee631d20f0f3529
|
|
4
|
+
data.tar.gz: 520be7505e717ec39c30b3750a2a733c2e7cb695
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c98753e5e97c5fcb0470273ceac46d96e3588e273b071bc678acf7afd213fea41171769483d01166c96ba9af04f721840c833c9ce5deb123265b16d2c0eed3cc
|
|
7
|
+
data.tar.gz: 367ac848a05c75fa14507716fc86657df91a9b874c704ff354ad1c14cfea0c4f756642c23ffd02908f808198017225d246b169ea1f430fa74474ec8efb63822c
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.695
|
data/lib/v20210526/client.rb
CHANGED
|
@@ -653,10 +653,14 @@ module TencentCloud
|
|
|
653
653
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
654
654
|
end
|
|
655
655
|
|
|
656
|
-
#
|
|
657
|
-
|
|
658
|
-
#
|
|
659
|
-
#
|
|
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`
|
|
@@ -1089,7 +1093,9 @@ module TencentCloud
|
|
|
1089
1093
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
1090
1094
|
end
|
|
1091
1095
|
|
|
1092
|
-
#
|
|
1096
|
+
# 获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息,支持设置过滤条件以筛选员工查询结果。
|
|
1097
|
+
|
|
1098
|
+
# **注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
|
|
1093
1099
|
|
|
1094
1100
|
# @param request: Request instance for ChannelDescribeEmployees.
|
|
1095
1101
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeEmployeesRequest`
|
|
@@ -1351,12 +1357,13 @@ module TencentCloud
|
|
|
1351
1357
|
# 提交申请出证报告任务并返回报告ID。
|
|
1352
1358
|
|
|
1353
1359
|
# 注意:
|
|
1354
|
-
#
|
|
1355
|
-
#
|
|
1356
|
-
#
|
|
1357
|
-
#
|
|
1360
|
+
# - 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
|
|
1361
|
+
# - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
|
|
1362
|
+
# - 合同流程必须**所有参与方已经签署完成**。
|
|
1363
|
+
# - 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
|
|
1364
|
+
|
|
1358
1365
|
|
|
1359
|
-
#
|
|
1366
|
+
# 
|
|
1360
1367
|
|
|
1361
1368
|
# @param request: Request instance for CreateChannelFlowEvidenceReport.
|
|
1362
1369
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::CreateChannelFlowEvidenceReportRequest`
|
|
@@ -1639,7 +1646,14 @@ module TencentCloud
|
|
|
1639
1646
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
1640
1647
|
end
|
|
1641
1648
|
|
|
1642
|
-
#
|
|
1649
|
+
# 获取出证报告任务执行结果,返回报告 URL。
|
|
1650
|
+
|
|
1651
|
+
# 注意:
|
|
1652
|
+
|
|
1653
|
+
# - 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
|
|
1654
|
+
# - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
|
|
1655
|
+
|
|
1656
|
+
# 
|
|
1643
1657
|
|
|
1644
1658
|
# @param request: Request instance for DescribeChannelFlowEvidenceReport.
|
|
1645
1659
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeChannelFlowEvidenceReportRequest`
|
|
@@ -1767,6 +1781,8 @@ module TencentCloud
|
|
|
1767
1781
|
# - 发起方和签署方的填写控件 Components
|
|
1768
1782
|
# - 签署方的签署控件 SignComponents
|
|
1769
1783
|
|
|
1784
|
+
# 
|
|
1785
|
+
|
|
1770
1786
|
# **适用场景**
|
|
1771
1787
|
# 该接口常用来配合<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
1788
|
# 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
|
|
@@ -1976,9 +1992,20 @@ module TencentCloud
|
|
|
1976
1992
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
1977
1993
|
end
|
|
1978
1994
|
|
|
1979
|
-
# 此接口(SyncProxyOrganization
|
|
1980
|
-
|
|
1981
|
-
#
|
|
1995
|
+
# 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
|
|
1996
|
+
|
|
1997
|
+
# 注意:
|
|
1998
|
+
|
|
1999
|
+
# - **需要在<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形
|
|
2000
|
+
# - **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题
|
|
2001
|
+
|
|
2002
|
+
# 
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
# - **企业统一社会信用代码**: 对应上图中的**1**
|
|
2006
|
+
# - **第三方平台子客企业名称**: 对应上图中的**2**
|
|
2007
|
+
# - **企业法定代表人的名字**:对应上图中的**3**
|
|
2008
|
+
# - **企业详细住所**:对应上图中的**4**
|
|
1982
2009
|
|
|
1983
2010
|
# @param request: Request instance for SyncProxyOrganization.
|
|
1984
2011
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationRequest`
|
|
@@ -2004,7 +2031,7 @@ module TencentCloud
|
|
|
2004
2031
|
|
|
2005
2032
|
# 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
2006
2033
|
|
|
2007
|
-
# -
|
|
2034
|
+
# - **新增员工的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
2008
2035
|
|
|
2009
2036
|
# - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
2010
2037
|
|
|
@@ -2013,7 +2040,7 @@ module TencentCloud
|
|
|
2013
2040
|
# **注**:
|
|
2014
2041
|
# - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
2015
2042
|
# - <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
2016
|
-
# -
|
|
2043
|
+
# - 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
2017
2044
|
|
|
2018
2045
|
# @param request: Request instance for SyncProxyOrganizationOperators.
|
|
2019
2046
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::SyncProxyOrganizationOperatorsRequest`
|
data/lib/v20210526/models.rb
CHANGED
|
@@ -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:
|
|
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:
|
|
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
|
|
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 可参考接口
|
|
2381
|
+
# @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
|
|
2367
2382
|
# @type PermissionGroups: Array
|
|
2368
2383
|
|
|
2369
2384
|
attr_accessor :Name, :Agent, :Description, :PermissionGroups
|
|
@@ -2967,12 +2982,14 @@ module TencentCloud
|
|
|
2967
2982
|
# @type Limit: Integer
|
|
2968
2983
|
# @param Filters: 查询的关键字段,支持Key-Values查询。可选键值如下:
|
|
2969
2984
|
# <ul>
|
|
2970
|
-
# <li>Key:**"Status"
|
|
2971
|
-
#
|
|
2972
|
-
# <li>Key:**"StaffOpenId"
|
|
2985
|
+
# <li>Key:**"Status"**,Values: **["IsVerified"]**, 查询已实名的员工</li>
|
|
2986
|
+
# <li>Key:**"Status"**,Values: **["QuiteJob"]**, 查询离职员工</li>
|
|
2987
|
+
# <li>Key:**"StaffOpenId"**,Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
|
|
2973
2988
|
# </ul>
|
|
2989
|
+
# 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
|
|
2974
2990
|
# @type Filters: Array
|
|
2975
|
-
# @param Offset:
|
|
2991
|
+
# @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页。
|
|
2992
|
+
# 页码从 0 开始,即首页为 0,最大20000。
|
|
2976
2993
|
# @type Offset: Integer
|
|
2977
2994
|
# @param Operator: 暂未开放
|
|
2978
2995
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -3518,7 +3535,7 @@ module TencentCloud
|
|
|
3518
3535
|
# @type RoleId: String
|
|
3519
3536
|
# @param Description: 角色描述,最大长度为50个字符
|
|
3520
3537
|
# @type Description: String
|
|
3521
|
-
# @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口
|
|
3538
|
+
# @param PermissionGroups: 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
|
|
3522
3539
|
# @type PermissionGroups: Array
|
|
3523
3540
|
|
|
3524
3541
|
attr_accessor :Agent, :Name, :RoleId, :Description, :PermissionGroups
|
|
@@ -3669,10 +3686,16 @@ module TencentCloud
|
|
|
3669
3686
|
# ChannelVerifyPdf请求参数结构体
|
|
3670
3687
|
class ChannelVerifyPdfRequest < TencentCloud::Common::AbstractModel
|
|
3671
3688
|
# @param FlowId: 合同流程ID,为32位字符串。
|
|
3672
|
-
# 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
3673
3689
|
# @type FlowId: String
|
|
3674
|
-
# @param Agent:
|
|
3675
|
-
|
|
3690
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3691
|
+
|
|
3692
|
+
# 此接口下面信息必填。
|
|
3693
|
+
# <ul>
|
|
3694
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
3695
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3696
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3697
|
+
# </ul>
|
|
3698
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
3676
3699
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
3677
3700
|
# @param Operator: 暂未开放
|
|
3678
3701
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -3708,15 +3731,10 @@ module TencentCloud
|
|
|
3708
3731
|
# <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
|
|
3709
3732
|
# <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
|
|
3710
3733
|
# <li>**3**:文件被篡改。</li>
|
|
3711
|
-
# <li>**4
|
|
3734
|
+
# <li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
|
|
3712
3735
|
# <li>**5**:异常:文件签名格式错误。</li></ul>
|
|
3713
3736
|
# @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>
|
|
3737
|
+
# @param PdfVerifyResults: 验签结果详情,所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
|
|
3720
3738
|
# @type PdfVerifyResults: Array
|
|
3721
3739
|
# @param VerifySerialNo: 验签序列号, 为11为数组组成的字符串
|
|
3722
3740
|
# @type VerifySerialNo: String
|
|
@@ -4187,14 +4205,15 @@ module TencentCloud
|
|
|
4187
4205
|
|
|
4188
4206
|
# CreateChannelFlowEvidenceReport请求参数结构体
|
|
4189
4207
|
class CreateChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
|
|
4190
|
-
# @param Agent:
|
|
4208
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4191
4209
|
|
|
4192
4210
|
# 此接口下面信息必填。
|
|
4193
4211
|
# <ul>
|
|
4194
|
-
# <li>渠道应用标识: Agent.
|
|
4195
|
-
# <li>第三方平台子客企业标识: Agent.
|
|
4196
|
-
# <li>第三方平台子客企业中的员工标识: Agent.
|
|
4212
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
4213
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4214
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4197
4215
|
# </ul>
|
|
4216
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
4198
4217
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
4199
4218
|
# @param FlowId: 合同流程ID,为32位字符串。
|
|
4200
4219
|
# 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
@@ -4913,9 +4932,17 @@ module TencentCloud
|
|
|
4913
4932
|
|
|
4914
4933
|
# DescribeChannelFlowEvidenceReport请求参数结构体
|
|
4915
4934
|
class DescribeChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
|
|
4916
|
-
# @param Agent:
|
|
4935
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4936
|
+
|
|
4937
|
+
# 此接口下面信息必填。
|
|
4938
|
+
# <ul>
|
|
4939
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
4940
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4941
|
+
# <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4942
|
+
# </ul>
|
|
4943
|
+
# 第三方平台子客企业和员工必须已经经过实名认证
|
|
4917
4944
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
4918
|
-
# @param ReportId:
|
|
4945
|
+
# @param ReportId: 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
|
|
4919
4946
|
# @type ReportId: String
|
|
4920
4947
|
# @param Operator: 暂未开放
|
|
4921
4948
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
@@ -4946,14 +4973,14 @@ module TencentCloud
|
|
|
4946
4973
|
|
|
4947
4974
|
# DescribeChannelFlowEvidenceReport返回参数结构体
|
|
4948
4975
|
class DescribeChannelFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
|
|
4949
|
-
# @param ReportUrl:
|
|
4976
|
+
# @param ReportUrl: 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
|
|
4950
4977
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
|
4951
4978
|
# @type ReportUrl: String
|
|
4952
|
-
# @param Status:
|
|
4979
|
+
# @param Status: 出证任务执行的状态, 状态含义如下:
|
|
4953
4980
|
|
|
4954
|
-
#
|
|
4955
|
-
#
|
|
4956
|
-
#
|
|
4981
|
+
# <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
|
|
4982
|
+
# <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
|
|
4983
|
+
# <li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
|
|
4957
4984
|
# @type Status: String
|
|
4958
4985
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4959
4986
|
# @type RequestId: String
|
|
@@ -5992,17 +6019,24 @@ module TencentCloud
|
|
|
5992
6019
|
end
|
|
5993
6020
|
end
|
|
5994
6021
|
|
|
5995
|
-
#
|
|
6022
|
+
# 签署人签署链接信息。
|
|
5996
6023
|
class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
|
|
5997
|
-
# @param SignUrl:
|
|
6024
|
+
# @param SignUrl: 签署短链接。</br>
|
|
6025
|
+
# 注意:
|
|
6026
|
+
# - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
6027
|
+
# - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
5998
6028
|
# @type SignUrl: String
|
|
5999
|
-
# @param ApproverType:
|
|
6029
|
+
# @param ApproverType: 签署人类型。
|
|
6030
|
+
# - **PERSON**: 个人
|
|
6000
6031
|
# @type ApproverType: String
|
|
6001
|
-
# @param Name:
|
|
6032
|
+
# @param Name: 签署人姓名。
|
|
6002
6033
|
# @type Name: String
|
|
6003
|
-
# @param Mobile:
|
|
6034
|
+
# @param Mobile: 签署人手机号。
|
|
6004
6035
|
# @type Mobile: String
|
|
6005
|
-
# @param LongUrl:
|
|
6036
|
+
# @param LongUrl: 签署长链接。</br>
|
|
6037
|
+
# 注意:
|
|
6038
|
+
# - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
6039
|
+
# - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
6006
6040
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
|
6007
6041
|
# @type LongUrl: String
|
|
6008
6042
|
|
|
@@ -7074,25 +7108,41 @@ module TencentCloud
|
|
|
7074
7108
|
end
|
|
7075
7109
|
end
|
|
7076
7110
|
|
|
7077
|
-
#
|
|
7111
|
+
# 合同验签每个签署区的信息
|
|
7078
7112
|
class PdfVerifyResult < TencentCloud::Common::AbstractModel
|
|
7079
|
-
# @param VerifyResult:
|
|
7113
|
+
# @param VerifyResult: 验签结果详情,每个签名域对应的验签结果。状态值如下
|
|
7114
|
+
# <ul><li> **1** :验签成功,在电子签签署</li>
|
|
7115
|
+
# <li> **2** :验签成功,在其他平台签署</li>
|
|
7116
|
+
# <li> **3** :验签失败</li>
|
|
7117
|
+
# <li> **4** :pdf文件没有签名域</li>
|
|
7118
|
+
# <li> **5** :文件签名格式错误</li></ul>
|
|
7080
7119
|
# @type VerifyResult: Integer
|
|
7081
|
-
# @param SignPlatform:
|
|
7120
|
+
# @param SignPlatform: 签署平台
|
|
7121
|
+
# 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
|
|
7122
|
+
# 如果文件不在腾讯电子签平台签署,则为**其他平台**。
|
|
7082
7123
|
# @type SignPlatform: String
|
|
7083
|
-
# @param SignerName:
|
|
7124
|
+
# @param SignerName: 申请证书的主体的名字
|
|
7125
|
+
|
|
7126
|
+
# 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
|
|
7127
|
+
# **企业**: ESS@企业名称@平台生成的数字编码
|
|
7128
|
+
# **个人**: ESS@个人姓名@证件号@平台生成的数字编码
|
|
7129
|
+
|
|
7130
|
+
# 如果在其他平台签署的, 主体的名字参考其他平台的说明
|
|
7084
7131
|
# @type SignerName: String
|
|
7085
|
-
# @param SignTime:
|
|
7132
|
+
# @param SignTime: 签署时间的Unix时间戳,单位毫秒
|
|
7086
7133
|
# @type SignTime: Integer
|
|
7087
|
-
# @param SignAlgorithm:
|
|
7134
|
+
# @param SignAlgorithm: 证书签名算法, 如SHA1withRSA等算法
|
|
7088
7135
|
# @type SignAlgorithm: String
|
|
7089
|
-
# @param CertSn:
|
|
7136
|
+
# @param CertSn: CA供应商下发给用户的证书编号
|
|
7137
|
+
|
|
7138
|
+
# 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
|
|
7090
7139
|
# @type CertSn: String
|
|
7091
|
-
# @param CertNotBefore:
|
|
7140
|
+
# @param CertNotBefore: 证书起始时间的Unix时间戳,单位毫秒
|
|
7092
7141
|
# @type CertNotBefore: Integer
|
|
7093
|
-
# @param CertNotAfter:
|
|
7142
|
+
# @param CertNotAfter: 证书过期时间的时间戳,单位毫秒
|
|
7094
7143
|
# @type CertNotAfter: Integer
|
|
7095
|
-
# @param SignType:
|
|
7144
|
+
# @param SignType: 签名类型, 保留字段, 现在全部为0
|
|
7145
|
+
|
|
7096
7146
|
# @type SignType: Integer
|
|
7097
7147
|
# @param ComponentPosX: 签名域横坐标,单位px
|
|
7098
7148
|
# @type ComponentPosX: Float
|
|
@@ -7329,7 +7379,7 @@ module TencentCloud
|
|
|
7329
7379
|
# @param IdCardType: 签署方经办人的证件类型,支持以下类型
|
|
7330
7380
|
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
7331
7381
|
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
7332
|
-
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
|
7382
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
7333
7383
|
# @type IdCardType: String
|
|
7334
7384
|
# @param IdCardNumber: 经办人证件号
|
|
7335
7385
|
# @type IdCardNumber: String
|
|
@@ -7480,7 +7530,7 @@ module TencentCloud
|
|
|
7480
7530
|
# @param IdCardType: 签署方经办人的证件类型,支持以下类型
|
|
7481
7531
|
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
7482
7532
|
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
7483
|
-
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
|
7533
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
7484
7534
|
# @type IdCardType: String
|
|
7485
7535
|
# @param IdCardNumber: 证件号码,应符合以下规则
|
|
7486
7536
|
# <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
@@ -7962,30 +8012,43 @@ module TencentCloud
|
|
|
7962
8012
|
|
|
7963
8013
|
# SyncProxyOrganization请求参数结构体
|
|
7964
8014
|
class SyncProxyOrganizationRequest < TencentCloud::Common::AbstractModel
|
|
7965
|
-
# @param Agent:
|
|
7966
|
-
|
|
8015
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
8016
|
+
|
|
8017
|
+
# 此接口下面信息必填。
|
|
8018
|
+
# <ul>
|
|
8019
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
|
8020
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
8021
|
+
# </ul>
|
|
7967
8022
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
7968
|
-
# @param ProxyOrganizationName:
|
|
8023
|
+
# @param ProxyOrganizationName: 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
|
|
8024
|
+
# 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
|
|
7969
8025
|
# @type ProxyOrganizationName: String
|
|
7970
8026
|
# @param BusinessLicense: 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
|
|
7971
8027
|
# @type BusinessLicense: String
|
|
7972
8028
|
# @param UniformSocialCreditCode: 第三方平台子客企业统一社会信用代码,最大长度200个字符
|
|
7973
8029
|
# @type UniformSocialCreditCode: String
|
|
7974
|
-
# @param ProxyLegalName:
|
|
8030
|
+
# @param ProxyLegalName: 第三方平台子客企业法定代表人的名字
|
|
7975
8031
|
# @type ProxyLegalName: String
|
|
7976
8032
|
# @param Operator: 暂未开放
|
|
7977
8033
|
# @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
|
|
7978
|
-
# @param ProxyLegalIdCardType:
|
|
8034
|
+
# @param ProxyLegalIdCardType: 第三方平台子客企业法定代表人的证件类型,支持以下类型
|
|
8035
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
|
|
8036
|
+
# 注: `现在仅支持ID_CARD居民身份证类型`
|
|
7979
8037
|
# @type ProxyLegalIdCardType: String
|
|
7980
|
-
# @param ProxyLegalIdCardNumber:
|
|
8038
|
+
# @param ProxyLegalIdCardNumber: 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
|
|
8039
|
+
# <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
7981
8040
|
# @type ProxyLegalIdCardNumber: String
|
|
8041
|
+
# @param ProxyAddress: 第三方平台子客企业详细住所,最大长度500个字符
|
|
8042
|
+
|
|
8043
|
+
# 注:`需要符合省市区详情的格式例如: XX省XX市XX区街道具体地址`
|
|
8044
|
+
# @type ProxyAddress: String
|
|
7982
8045
|
|
|
7983
|
-
attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator, :ProxyLegalIdCardType, :ProxyLegalIdCardNumber
|
|
8046
|
+
attr_accessor :Agent, :ProxyOrganizationName, :BusinessLicense, :UniformSocialCreditCode, :ProxyLegalName, :Operator, :ProxyLegalIdCardType, :ProxyLegalIdCardNumber, :ProxyAddress
|
|
7984
8047
|
extend Gem::Deprecate
|
|
7985
8048
|
deprecate :Operator, :none, 2023, 11
|
|
7986
8049
|
deprecate :Operator=, :none, 2023, 11
|
|
7987
8050
|
|
|
7988
|
-
def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil, proxylegalidcardtype=nil, proxylegalidcardnumber=nil)
|
|
8051
|
+
def initialize(agent=nil, proxyorganizationname=nil, businesslicense=nil, uniformsocialcreditcode=nil, proxylegalname=nil, operator=nil, proxylegalidcardtype=nil, proxylegalidcardnumber=nil, proxyaddress=nil)
|
|
7989
8052
|
@Agent = agent
|
|
7990
8053
|
@ProxyOrganizationName = proxyorganizationname
|
|
7991
8054
|
@BusinessLicense = businesslicense
|
|
@@ -7994,6 +8057,7 @@ module TencentCloud
|
|
|
7994
8057
|
@Operator = operator
|
|
7995
8058
|
@ProxyLegalIdCardType = proxylegalidcardtype
|
|
7996
8059
|
@ProxyLegalIdCardNumber = proxylegalidcardnumber
|
|
8060
|
+
@ProxyAddress = proxyaddress
|
|
7997
8061
|
end
|
|
7998
8062
|
|
|
7999
8063
|
def deserialize(params)
|
|
@@ -8011,6 +8075,7 @@ module TencentCloud
|
|
|
8011
8075
|
end
|
|
8012
8076
|
@ProxyLegalIdCardType = params['ProxyLegalIdCardType']
|
|
8013
8077
|
@ProxyLegalIdCardNumber = params['ProxyLegalIdCardNumber']
|
|
8078
|
+
@ProxyAddress = params['ProxyAddress']
|
|
8014
8079
|
end
|
|
8015
8080
|
end
|
|
8016
8081
|
|
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.
|
|
4
|
+
version: 3.0.695
|
|
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-
|
|
11
|
+
date: 2023-11-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|