tencentcloud-sdk-essbasic 3.0.841 → 3.0.843
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/v20210526/client.rb +6 -4
- data/lib/v20210526/models.rb +64 -9
- 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: ad07ec0faa7de948191d19d8dbc1ff395f19830a
|
|
4
|
+
data.tar.gz: e01624a2eaa71f874b93f20e59a5f88eb335555a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 69de9f3fb6b00a6d2f87bbc46f43f71c1b673b061abd1cb28cd54c5f931ccc9cf84ae1580c656dbce9738d90d159c470b6c842daa4e8865bd7a36f6306c42b50
|
|
7
|
+
data.tar.gz: 6d4d61099301c9df297185749630e76f43a1822eeb042acf2daf0c5c55903311f2cb9187cfd830f05f13c793ed95037e03d7d87d313e5b3d5c7c8a52c89f3d7b
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.843
|
data/lib/v20210526/client.rb
CHANGED
|
@@ -681,11 +681,10 @@ module TencentCloud
|
|
|
681
681
|
# 该接口用于发起合同后，生成用户的签署链接 <br/>
|
|
682
682
|
|
|
683
683
|
# **注意**
|
|
684
|
-
# 1.
|
|
685
|
-
# 2.
|
|
686
|
-
# 3. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
|
|
684
|
+
# 1. 该签署**链接有效期为30分钟**，过期后将失效，如需签署可重新创建签署链接 。
|
|
685
|
+
# 2. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
|
|
687
686
|
# 跳转到小程序的实现，参考微信官方文档（分为<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>。
|
|
688
|
-
#
|
|
687
|
+
# 3. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
689
688
|
|
|
690
689
|
# @param request: Request instance for ChannelCreateFlowSignUrl.
|
|
691
690
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`
|
|
@@ -2561,6 +2560,9 @@ module TencentCloud
|
|
|
2561
2560
|
# httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
2562
2561
|
# ```
|
|
2563
2562
|
|
|
2563
|
+
# <font color="red">相关视频指引</font> <br>
|
|
2564
|
+
# 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
|
|
2565
|
+
|
|
2564
2566
|
# @param request: Request instance for UploadFiles.
|
|
2565
2567
|
# @type request: :class:`Tencentcloud::essbasic::V20210526::UploadFilesRequest`
|
|
2566
2568
|
# @rtype: :class:`Tencentcloud::essbasic::V20210526::UploadFilesResponse`
|
data/lib/v20210526/models.rb
CHANGED
|
@@ -1378,19 +1378,22 @@ module TencentCloud
|
|
|
1378
1378
|
# </li>
|
|
1379
1379
|
# </ul>
|
|
1380
1380
|
# @type UserData: String
|
|
1381
|
+
# @param Option: 个性化参数，用于控制页面展示内容
|
|
1382
|
+
# @type Option: :class:`Tencentcloud::Essbasic.v20210526.models.EmbedUrlOption`
|
|
1381
1383
|
|
|
1382
|
-
attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator, :UserData
|
|
1384
|
+
attr_accessor :Agent, :EmbedType, :BusinessId, :HiddenComponents, :Operator, :UserData, :Option
|
|
1383
1385
|
extend Gem::Deprecate
|
|
1384
1386
|
deprecate :Operator, :none, 2024, 6
|
|
1385
1387
|
deprecate :Operator=, :none, 2024, 6
|
|
1386
1388
|
|
|
1387
|
-
def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil, userdata=nil)
|
|
1389
|
+
def initialize(agent=nil, embedtype=nil, businessid=nil, hiddencomponents=nil, operator=nil, userdata=nil, option=nil)
|
|
1388
1390
|
@Agent = agent
|
|
1389
1391
|
@EmbedType = embedtype
|
|
1390
1392
|
@BusinessId = businessid
|
|
1391
1393
|
@HiddenComponents = hiddencomponents
|
|
1392
1394
|
@Operator = operator
|
|
1393
1395
|
@UserData = userdata
|
|
1396
|
+
@Option = option
|
|
1394
1397
|
end
|
|
1395
1398
|
|
|
1396
1399
|
def deserialize(params)
|
|
@@ -1406,6 +1409,10 @@ module TencentCloud
|
|
|
1406
1409
|
@Operator.deserialize(params['Operator'])
|
|
1407
1410
|
end
|
|
1408
1411
|
@UserData = params['UserData']
|
|
1412
|
+
unless params['Option'].nil?
|
|
1413
|
+
@Option = EmbedUrlOption.new
|
|
1414
|
+
@Option.deserialize(params['Option'])
|
|
1415
|
+
end
|
|
1409
1416
|
end
|
|
1410
1417
|
end
|
|
1411
1418
|
|
|
@@ -2305,7 +2312,12 @@ module TencentCloud
|
|
|
2305
2312
|
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
|
2306
2313
|
# @param FlowIds: 请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。
|
|
2307
2314
|
# @type FlowIds: Array
|
|
2308
|
-
# @param OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。
|
|
2315
|
+
# @param OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。
|
|
2316
|
+
|
|
2317
|
+
# <ul>
|
|
2318
|
+
# <li>1. 若OpenId为空，Name和Mobile 必须提供。</li>
|
|
2319
|
+
# <li>2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。 </li>
|
|
2320
|
+
# </ul>
|
|
2309
2321
|
# @type OpenId: String
|
|
2310
2322
|
# @param Name: 签署方经办人的姓名。
|
|
2311
2323
|
# 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
|
|
@@ -3682,16 +3694,19 @@ module TencentCloud
|
|
|
3682
3694
|
|
|
3683
3695
|
# 注: `为空时查询所有类型的印章。`
|
|
3684
3696
|
# @type SealTypes: Array
|
|
3697
|
+
# @param SealStatuses: 查询的印章状态列表。 <ul> <li>空，只查询启用状态的印章；</li> <li>ALL，查询所有状态的印章；</li> <li>CHECKING，查询待审核的印章；</li> <li>SUCCESS，查询启用状态的印章；</li> <li>FAIL，查询印章审核拒绝的印章；</li> <li>DISABLE，查询已停用的印章；</li> <li>STOPPED，查询已终止的印章；</li> <li>VOID，查询已作废的印章；</li> <li>INVALID，查询已失效的印章；</li> </ul>
|
|
3698
|
+
# @type SealStatuses: Array
|
|
3685
3699
|
|
|
3686
|
-
attr_accessor :Agent, :Limit, :Offset, :InfoType, :SealId, :SealTypes
|
|
3700
|
+
attr_accessor :Agent, :Limit, :Offset, :InfoType, :SealId, :SealTypes, :SealStatuses
|
|
3687
3701
|
|
|
3688
|
-
def initialize(agent=nil, limit=nil, offset=nil, infotype=nil, sealid=nil, sealtypes=nil)
|
|
3702
|
+
def initialize(agent=nil, limit=nil, offset=nil, infotype=nil, sealid=nil, sealtypes=nil, sealstatuses=nil)
|
|
3689
3703
|
@Agent = agent
|
|
3690
3704
|
@Limit = limit
|
|
3691
3705
|
@Offset = offset
|
|
3692
3706
|
@InfoType = infotype
|
|
3693
3707
|
@SealId = sealid
|
|
3694
3708
|
@SealTypes = sealtypes
|
|
3709
|
+
@SealStatuses = sealstatuses
|
|
3695
3710
|
end
|
|
3696
3711
|
|
|
3697
3712
|
def deserialize(params)
|
|
@@ -3704,6 +3719,7 @@ module TencentCloud
|
|
|
3704
3719
|
@InfoType = params['InfoType']
|
|
3705
3720
|
@SealId = params['SealId']
|
|
3706
3721
|
@SealTypes = params['SealTypes']
|
|
3722
|
+
@SealStatuses = params['SealStatuses']
|
|
3707
3723
|
end
|
|
3708
3724
|
end
|
|
3709
3725
|
|
|
@@ -4811,7 +4827,13 @@ module TencentCloud
|
|
|
4811
4827
|
# <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
|
|
4812
4828
|
# <b>参考样例</b>：`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
|
|
4813
4829
|
# 印章的对应关系参考下图
|
|
4814
|
-
# 
|
|
4830
|
+
# <br><br>
|
|
4831
|
+
# <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型
|
|
4832
|
+
# <ul><li> <b>OFFICIAL</b> : 企业公章</li>
|
|
4833
|
+
# <li> <b>CONTRACT</b> : 合同专用章</li>
|
|
4834
|
+
# <li> <b>FINANCE</b> : 财务专用章</li>
|
|
4835
|
+
# <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
|
|
4836
|
+
# <b>参考样例</b>：`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
|
|
4815
4837
|
|
|
4816
4838
|
# <font color="red">ComponentType为SIGN_DATE时</font>，支持以下参数：
|
|
4817
4839
|
# <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体"</li>
|
|
@@ -4975,7 +4997,14 @@ module TencentCloud
|
|
|
4975
4997
|
# @type ComponentType: String
|
|
4976
4998
|
# @param ComponentValue: 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
|
|
4977
4999
|
|
|
4978
|
-
# 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id
|
|
5000
|
+
# 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）或者以下印章类型
|
|
5001
|
+
|
|
5002
|
+
# <ul><li> <b>OFFICIAL</b> : 企业公章</li>
|
|
5003
|
+
# <li> <b>CONTRACT</b> : 合同专用章</li>
|
|
5004
|
+
# <li> <b>FINANCE</b> : 财务专用章</li>
|
|
5005
|
+
# <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
|
|
5006
|
+
|
|
5007
|
+
# 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`
|
|
4979
5008
|
|
|
4980
5009
|
# 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
|
|
4981
5010
|
|
|
@@ -6987,6 +7016,32 @@ module TencentCloud
|
|
|
6987
7016
|
end
|
|
6988
7017
|
end
|
|
6989
7018
|
|
|
7019
|
+
# 创建嵌入式页面url个性化参数
|
|
7020
|
+
class EmbedUrlOption < TencentCloud::Common::AbstractModel
|
|
7021
|
+
# @param ShowFlowDetailComponent: 合同详情页面是否展示合同控件信息
|
|
7022
|
+
# <br/>true:允许在合同详情页展示控件
|
|
7023
|
+
# <br/>false:不允许在合同详情页展示控件
|
|
7024
|
+
# <br/>默认false,在合同详情页不展示控件
|
|
7025
|
+
# @type ShowFlowDetailComponent: Boolean
|
|
7026
|
+
# @param ShowTemplateComponent: 模版预览页面是否展示空间信息
|
|
7027
|
+
# <br/>true:允许在模版预览页展示控件
|
|
7028
|
+
# <br/>false:不允许在模版预览页展示控件
|
|
7029
|
+
# <br/>默认false,在模版预览页不展示控件
|
|
7030
|
+
# @type ShowTemplateComponent: Boolean
|
|
7031
|
+
|
|
7032
|
+
attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent
|
|
7033
|
+
|
|
7034
|
+
def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil)
|
|
7035
|
+
@ShowFlowDetailComponent = showflowdetailcomponent
|
|
7036
|
+
@ShowTemplateComponent = showtemplatecomponent
|
|
7037
|
+
end
|
|
7038
|
+
|
|
7039
|
+
def deserialize(params)
|
|
7040
|
+
@ShowFlowDetailComponent = params['ShowFlowDetailComponent']
|
|
7041
|
+
@ShowTemplateComponent = params['ShowTemplateComponent']
|
|
7042
|
+
end
|
|
7043
|
+
end
|
|
7044
|
+
|
|
6990
7045
|
# 扩展服务开通和授权的详细信息
|
|
6991
7046
|
class ExtentServiceAuthInfo < TencentCloud::Common::AbstractModel
|
|
6992
7047
|
# @param Type: 扩展服务类型
|
|
@@ -7283,7 +7338,7 @@ module TencentCloud
|
|
|
7283
7338
|
|
|
7284
7339
|
# **各种场景传参说明**:
|
|
7285
7340
|
|
|
7286
|
-
# <table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（必传）OpenId：企业员工标识</li> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> <li>（固定）ApproverOption.FillType：需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（必传）OpenId：企业员工标识</li> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（固定）ApproverType：需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）OrganizationName：SaaS企业的名字</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li
|
|
7341
|
+
# <table> <thead> <tr> <th>场景编号</th> <th>发起方类型</th> <th>签署方类型</th> <th>签署方传参说明</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>第三方子企业A员工</td> <td>第三方子企业A员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（必传）OpenId：企业员工标识</li> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> </ul> </td> </tr> <tr> <td>场景二</td> <td>第三方子企业A员工</td> <td>第三方子企业B(不指定经办人走领取方式)</td> <td> <ul> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> <li>（固定）ApproverOption.FillType：需设置为1</li> </ul> </td> </tr> <tr> <td>场景三</td> <td>第三方子企业A员工</td> <td>第三方子企业B员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（必传）OpenId：企业员工标识</li> <li>（必传）OrganizationName：子企业名称</li> <li>（必传）OrganizationOpenId：子企业的标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> </ul></td> </tr> <tr> <td>场景四</td> <td>第三方子企业A员工</td> <td>个人/自然人</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（固定）ApproverType：需设置为PERSON</li> </ul> </td> </tr> <tr> <td>场景五</td> <td>第三方子企业A员工</td> <td>SaaS平台企业员工</td> <td> <ul> <li>（选填）IdCardNumber和IdCardType：证件类型和证件号</li> <li>（必传）OrganizationName：SaaS企业的名字</li> <li>（必传）Name：签署方的名字</li> <li>（必传）Mobile：签署方的手机号</li> <li>（不传）OrganizationOpenId：子企业的标识</li> <li>（不传）OpenId：企业员工标识</li> <li>（固定）ApproverType：需设置为ORGANIZATION</li> <li>（固定）NotChannelOrganization：需设置为True</li> </ul> </td> </tr> </tbody> </table>
|
|
7287
7342
|
|
|
7288
7343
|
|
|
7289
7344
|
# **注1**: `使用模板发起合同时，RecipientId（模板发起合同时）必传`
|
|
@@ -7418,7 +7473,7 @@ module TencentCloud
|
|
|
7418
7473
|
|
|
7419
7474
|
# 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
|
|
7420
7475
|
# @type NotifyType: String
|
|
7421
|
-
# @param AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID
|
|
7476
|
+
# @param AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID,或者印章类型）或签名方式。
|
|
7422
7477
|
|
|
7423
7478
|
# 注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
|
|
7424
7479
|
# @type AddSignComponentsLimits: Array
|
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.843
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Tencent Cloud
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-06-
|
|
11
|
+
date: 2024-06-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|