tencentcloud-sdk-ess 3.0.913 → 3.0.915
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 +18 -11
- data/lib/v20201111/models.rb +30 -22
- 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: 059c454c8f306b096e521a2bc5829c91383922d1
|
|
4
|
+
data.tar.gz: 51e3836ef7145aab10abb3305879dcca51078848
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f147135c6a168bacddc53abcfd856581f3c892596ccc1b6b417f73659504c42341665fe8983bc9bfddcb3c6e5eb6ebcf6bd5ae92710253ef4eea4c3babfcdc67
|
|
7
|
+
data.tar.gz: c6929e7aca598c67bc79dd9b054448efdcabc600b4365cbe7254f241ad9ca8d7e9648ac9ec98724afa655a4d3afb28017b402112fc1776ec49d2b4b2b4fe35ce
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.915
|
data/lib/v20201111/client.rb
CHANGED
|
@@ -68,7 +68,7 @@ module TencentCloud
|
|
|
68
68
|
|
|
69
69
|
# 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
|
|
70
70
|
|
|
71
|
-
# 4. 撤销后可以看合同PDF内容的人员： 发起方的超管，
|
|
71
|
+
# 4. 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
|
|
72
72
|
|
|
73
73
|
# @param request: Request instance for CancelFlow.
|
|
74
74
|
# @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
|
|
@@ -164,6 +164,8 @@ module TencentCloud
|
|
|
164
164
|
|
|
165
165
|
# 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
|
|
166
166
|
|
|
167
|
+
# 4. 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
|
|
168
|
+
|
|
167
169
|
# @param request: Request instance for CreateBatchCancelFlowUrl.
|
|
168
170
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest`
|
|
169
171
|
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlResponse`
|
|
@@ -295,10 +297,9 @@ module TencentCloud
|
|
|
295
297
|
# 该接口用于发起合同后，生成个人用户的批量待办链接, 暂时不支持企业端签署。
|
|
296
298
|
# **注意：**
|
|
297
299
|
# 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
|
|
298
|
-
# 2.
|
|
299
|
-
# 3.
|
|
300
|
-
# 4.
|
|
301
|
-
# 5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
|
|
300
|
+
# 2. 该接口可生成C端签署人的批量签署/查看链接，**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件** 。
|
|
301
|
+
# 3. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
|
|
302
|
+
# 4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
|
|
302
303
|
# 跳转到小程序的实现，参考微信官方文档(分为<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>。
|
|
303
304
|
# 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
304
305
|
|
|
@@ -390,7 +391,7 @@ module TencentCloud
|
|
|
390
391
|
# ### 调用流程
|
|
391
392
|
# 该接口需要给对应的流程指定一个模板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>接口使用。具体逻辑可以参考下图:
|
|
392
393
|
|
|
393
|
-
# 
|
|
394
395
|
|
|
395
396
|
|
|
396
397
|
# ### 填充模板中定义的填写控件
|
|
@@ -578,7 +579,7 @@ module TencentCloud
|
|
|
578
579
|
|
|
579
580
|
# 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
|
|
580
581
|
|
|
581
|
-
# 
|
|
582
583
|
|
|
583
584
|
# 注：**静默（自动）签署不支持合同签署方存在填写**功能
|
|
584
585
|
# <br>
|
|
@@ -1547,6 +1548,8 @@ module TencentCloud
|
|
|
1547
1548
|
# <li>非原合同企业参与人发起解除协议时，需要有<code>解除合同的权限</code>。</li>
|
|
1548
1549
|
# </ul>
|
|
1549
1550
|
|
|
1551
|
+
# 
|
|
1552
|
+
|
|
1550
1553
|
# @param request: Request instance for CreateReleaseFlow.
|
|
1551
1554
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowRequest`
|
|
1552
1555
|
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowResponse`
|
|
@@ -2132,8 +2135,7 @@ module TencentCloud
|
|
|
2132
2135
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
2133
2136
|
end
|
|
2134
2137
|
|
|
2135
|
-
#
|
|
2136
|
-
# 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
2138
|
+
# 查询流程基础信息，主要用于<font color="red">查询合同的状态</font>信息。可以配合回调通知使用。
|
|
2137
2139
|
|
|
2138
2140
|
# 注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`
|
|
2139
2141
|
|
|
@@ -2159,7 +2161,12 @@ module TencentCloud
|
|
|
2159
2161
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
2160
2162
|
end
|
|
2161
2163
|
|
|
2162
|
-
# 可以根据合同流程ID
|
|
2164
|
+
# 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容，包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
# 如下图模板所示，发起后对方填写后，可以获取红框中用户填写的信息。
|
|
2168
|
+
|
|
2169
|
+
# 
|
|
2163
2170
|
|
|
2164
2171
|
# @param request: Request instance for DescribeFlowComponents.
|
|
2165
2172
|
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowComponentsRequest`
|
|
@@ -2819,7 +2826,7 @@ module TencentCloud
|
|
|
2819
2826
|
# 此接口用于启动流程。它是模板发起合同的最后一步。
|
|
2820
2827
|
# 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
|
|
2821
2828
|
|
|
2822
|
-
# 
|
|
2823
2830
|
|
|
2824
2831
|
# 注：
|
|
2825
2832
|
# 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
|
data/lib/v20201111/models.rb
CHANGED
|
@@ -130,12 +130,15 @@ module TencentCloud
|
|
|
130
130
|
# <li> 企业印章</li>
|
|
131
131
|
# <li> 骑缝章等签署控件</li></ul>
|
|
132
132
|
# @type SignComponents: Array
|
|
133
|
-
# @param ApproverIdCardType:
|
|
133
|
+
# @param ApproverIdCardType: 签署方经办人的证件类型，支持以下类型，样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
|
|
134
134
|
# <ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
|
|
135
135
|
# <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
|
|
136
136
|
# <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
|
|
137
137
|
# <li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
138
138
|
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
139
142
|
# 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
140
143
|
# @type ApproverIdCardType: String
|
|
141
144
|
# @param ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
|
|
@@ -150,7 +153,7 @@ module TencentCloud
|
|
|
150
153
|
# 注意：
|
|
151
154
|
# `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`
|
|
152
155
|
# @type NotifyType: String
|
|
153
|
-
# @param ApproverRole: 收据场景设置签署人角色类型,
|
|
156
|
+
# @param ApproverRole: 收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
|
|
154
157
|
# <ul><li> **1** :收款人</li>
|
|
155
158
|
# <li> **2** :开具人</li>
|
|
156
159
|
# <li> **3** :见证人</li></ul>
|
|
@@ -3531,9 +3534,9 @@ module TencentCloud
|
|
|
3531
3534
|
|
|
3532
3535
|
# CreateFlowSignUrl请求参数结构体
|
|
3533
3536
|
class CreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
|
|
3534
|
-
# @param FlowId: 合同流程ID
|
|
3535
|
-
|
|
3536
|
-
#
|
|
3537
|
+
# @param FlowId: 合同流程ID为32位字符串。
|
|
3538
|
+
|
|
3539
|
+
# 您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
|
|
3537
3540
|
# @type FlowId: String
|
|
3538
3541
|
# @param Operator: 执行本接口操作的员工信息。
|
|
3539
3542
|
# 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
|
|
@@ -3541,22 +3544,25 @@ module TencentCloud
|
|
|
3541
3544
|
# @param Agent: 代理企业和员工的信息。
|
|
3542
3545
|
# 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
|
|
3543
3546
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
|
3544
|
-
# @param FlowApproverInfos:
|
|
3547
|
+
# @param FlowApproverInfos: 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
|
|
3548
|
+
|
|
3549
|
+
# 注：
|
|
3550
|
+
# 1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。
|
|
3551
|
+
# 2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
|
|
3545
3552
|
|
|
3546
|
-
# 注:
|
|
3547
|
-
# `1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
|
|
3548
|
-
# `2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
|
|
3549
3553
|
# @type FlowApproverInfos: Array
|
|
3550
3554
|
# @param Organization: 机构信息，暂未开放
|
|
3551
3555
|
# @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
|
|
3552
3556
|
# @param JumpUrl: 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
|
|
3553
3557
|
# @type JumpUrl: String
|
|
3554
|
-
# @param UrlType:
|
|
3555
|
-
|
|
3556
|
-
# <li>1
|
|
3557
|
-
|
|
3558
|
-
#
|
|
3559
|
-
|
|
3558
|
+
# @param UrlType: 链接类型支持以下指定类型：
|
|
3559
|
+
|
|
3560
|
+
# <ul><li><b>0</b>: 签署链接（默认值），进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接，进入后可以预览合同当前的样子。</li></ul>
|
|
3561
|
+
|
|
3562
|
+
# 注：
|
|
3563
|
+
|
|
3564
|
+
# 1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
|
|
3565
|
+
# 2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
|
|
3560
3566
|
# @type UrlType: Integer
|
|
3561
3567
|
|
|
3562
3568
|
attr_accessor :FlowId, :Operator, :Agent, :FlowApproverInfos, :Organization, :JumpUrl, :UrlType
|
|
@@ -6899,11 +6905,10 @@ module TencentCloud
|
|
|
6899
6905
|
# 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
|
|
6900
6906
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
|
6901
6907
|
# @param FlowIds: 查询的合同流程ID列表最多支持100个流程ID。
|
|
6902
|
-
# 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
|
|
6903
6908
|
|
|
6904
|
-
#
|
|
6909
|
+
# 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
|
|
6905
6910
|
|
|
6906
|
-
# [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
|
|
6911
|
+
# 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
|
|
6907
6912
|
# @type FlowIds: Array
|
|
6908
6913
|
# @param Agent: 代理企业和员工的信息。
|
|
6909
6914
|
# 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
|
|
@@ -9056,11 +9061,14 @@ module TencentCloud
|
|
|
9056
9061
|
|
|
9057
9062
|
# 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
|
|
9058
9063
|
# @type Deadline: Integer
|
|
9059
|
-
# @param Intention:
|
|
9064
|
+
# @param Intention: <b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。
|
|
9060
9065
|
|
|
9061
|
-
#
|
|
9062
|
-
|
|
9063
|
-
#
|
|
9066
|
+
# 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
|
|
9067
|
+
|
|
9068
|
+
# 注意：
|
|
9069
|
+
# 1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。
|
|
9070
|
+
# 2. 使用视频认证时，<b>生成H5签署链接必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。
|
|
9071
|
+
# 3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
|
|
9064
9072
|
# @type Intention: :class:`Tencentcloud::Ess.v20201111.models.Intention`
|
|
9065
9073
|
|
|
9066
9074
|
attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes, :SignTypeSelector, :Deadline, :Intention
|
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.915
|
|
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-09-
|
|
11
|
+
date: 2024-09-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|