tencentcloud-sdk-essbasic 3.0.967 → 3.0.969
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 +62 -0
- data/lib/v20210526/models.rb +254 -6
- 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: 2e9bddaac09e116e58bb2e607f159b3f0e7f890f
|
4
|
+
data.tar.gz: 75f58b96cf2d6fca7161e5637e6fef7a54150156
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4e5476dce7a8657df52469fe22aec2433dcae2ad56abb0e71c66dfd7f3d77a9e61ae2f8e244da05cab6792dd4f456f1b01f4e668ed195917d6c303ba607282d5
|
7
|
+
data.tar.gz: 06bb271cf3097cef246cbd98e311baa6efce9bb23ec34eba7f83f6fa76fa528653958961d23cc40fd617113e6b5e03de873345de42e5bde7dc3f713004a5e86e
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.969
|
data/lib/v20210526/client.rb
CHANGED
@@ -29,6 +29,37 @@ module TencentCloud
|
|
29
29
|
end
|
30
30
|
|
31
31
|
|
32
|
+
# 该接口用于结束动态签署方2.0的合同流程。
|
33
|
+
|
34
|
+
|
35
|
+
# **功能开通**
|
36
|
+
# - 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>,然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
|
37
|
+
|
38
|
+
# **使用条件**
|
39
|
+
# - 此接口只能在<font color="red">合同处于非终态且<b>所有的签署方都已经完成签署</b></font>。一旦合同进入终态(例如:过期、拒签、撤销或者调用过此接口成功过),将无法通过此接口结束合同流程。
|
40
|
+
|
41
|
+
# @param request: Request instance for ArchiveDynamicFlow.
|
42
|
+
# @type request: :class:`Tencentcloud::essbasic::V20210526::ArchiveDynamicFlowRequest`
|
43
|
+
# @rtype: :class:`Tencentcloud::essbasic::V20210526::ArchiveDynamicFlowResponse`
|
44
|
+
def ArchiveDynamicFlow(request)
|
45
|
+
body = send_request('ArchiveDynamicFlow', request.serialize)
|
46
|
+
response = JSON.parse(body)
|
47
|
+
if response['Response'].key?('Error') == false
|
48
|
+
model = ArchiveDynamicFlowResponse.new
|
49
|
+
model.deserialize(response['Response'])
|
50
|
+
model
|
51
|
+
else
|
52
|
+
code = response['Response']['Error']['Code']
|
53
|
+
message = response['Response']['Error']['Message']
|
54
|
+
reqid = response['Response']['RequestId']
|
55
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
56
|
+
end
|
57
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
58
|
+
raise e
|
59
|
+
rescue StandardError => e
|
60
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
61
|
+
end
|
62
|
+
|
32
63
|
# 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
|
33
64
|
|
34
65
|
# 适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
@@ -328,6 +359,37 @@ module TencentCloud
|
|
328
359
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
329
360
|
end
|
330
361
|
|
362
|
+
# 接口(ChannelCreateDynamicFlowApprover)用来补充<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>发起的动态合同的签署人信息
|
363
|
+
# **注**:
|
364
|
+
# <ul>
|
365
|
+
# <li>此接口需要保证:渠道企业已开启:模块化计费能力,</li>
|
366
|
+
# <li>此接口需要保证:渠道应用已开启:动态签署人2.0能力</li>
|
367
|
+
# <li>此接口需要保证:合同发起时指定开启了动态合同</li>
|
368
|
+
# <li>此接口补充的动态签署人传参规则,请参考接口:<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>的签署人传参规则</li>
|
369
|
+
# </ul>
|
370
|
+
|
371
|
+
# @param request: Request instance for ChannelCreateDynamicFlowApprover.
|
372
|
+
# @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateDynamicFlowApproverRequest`
|
373
|
+
# @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateDynamicFlowApproverResponse`
|
374
|
+
def ChannelCreateDynamicFlowApprover(request)
|
375
|
+
body = send_request('ChannelCreateDynamicFlowApprover', request.serialize)
|
376
|
+
response = JSON.parse(body)
|
377
|
+
if response['Response'].key?('Error') == false
|
378
|
+
model = ChannelCreateDynamicFlowApproverResponse.new
|
379
|
+
model.deserialize(response['Response'])
|
380
|
+
model
|
381
|
+
else
|
382
|
+
code = response['Response']['Error']['Code']
|
383
|
+
message = response['Response']['Error']['Message']
|
384
|
+
reqid = response['Response']['RequestId']
|
385
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
|
386
|
+
end
|
387
|
+
rescue TencentCloud::Common::TencentCloudSDKException => e
|
388
|
+
raise e
|
389
|
+
rescue StandardError => e
|
390
|
+
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
391
|
+
end
|
392
|
+
|
331
393
|
# 本接口(ChannelCreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
|
332
394
|
# 1. 创建印章
|
333
395
|
# 2. 创建模板
|
data/lib/v20210526/models.rb
CHANGED
@@ -194,6 +194,68 @@ module TencentCloud
|
|
194
194
|
end
|
195
195
|
end
|
196
196
|
|
197
|
+
# ArchiveDynamicFlow请求参数结构体
|
198
|
+
class ArchiveDynamicFlowRequest < TencentCloud::Common::AbstractModel
|
199
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
200
|
+
|
201
|
+
# 此接口下面信息必填。
|
202
|
+
# <ul>
|
203
|
+
# <li>渠道应用标识: Agent.AppId</li>
|
204
|
+
# <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
205
|
+
# <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
206
|
+
# </ul>
|
207
|
+
# 第三方平台子客企业和员工必须已经过实名认证
|
208
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
209
|
+
# @param FlowId: 合同流程ID
|
210
|
+
# @type FlowId: String
|
211
|
+
|
212
|
+
attr_accessor :Agent, :FlowId
|
213
|
+
|
214
|
+
def initialize(agent=nil, flowid=nil)
|
215
|
+
@Agent = agent
|
216
|
+
@FlowId = flowid
|
217
|
+
end
|
218
|
+
|
219
|
+
def deserialize(params)
|
220
|
+
unless params['Agent'].nil?
|
221
|
+
@Agent = Agent.new
|
222
|
+
@Agent.deserialize(params['Agent'])
|
223
|
+
end
|
224
|
+
@FlowId = params['FlowId']
|
225
|
+
end
|
226
|
+
end
|
227
|
+
|
228
|
+
# ArchiveDynamicFlow返回参数结构体
|
229
|
+
class ArchiveDynamicFlowResponse < TencentCloud::Common::AbstractModel
|
230
|
+
# @param FlowId: 合同流程ID
|
231
|
+
# @type FlowId: String
|
232
|
+
# @param Approvers: 动态签署人的参与人信息
|
233
|
+
# @type Approvers: Array
|
234
|
+
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
235
|
+
# @type RequestId: String
|
236
|
+
|
237
|
+
attr_accessor :FlowId, :Approvers, :RequestId
|
238
|
+
|
239
|
+
def initialize(flowid=nil, approvers=nil, requestid=nil)
|
240
|
+
@FlowId = flowid
|
241
|
+
@Approvers = approvers
|
242
|
+
@RequestId = requestid
|
243
|
+
end
|
244
|
+
|
245
|
+
def deserialize(params)
|
246
|
+
@FlowId = params['FlowId']
|
247
|
+
unless params['Approvers'].nil?
|
248
|
+
@Approvers = []
|
249
|
+
params['Approvers'].each do |i|
|
250
|
+
channelarchivedynamicapproverdata_tmp = ChannelArchiveDynamicApproverData.new
|
251
|
+
channelarchivedynamicapproverdata_tmp.deserialize(i)
|
252
|
+
@Approvers << channelarchivedynamicapproverdata_tmp
|
253
|
+
end
|
254
|
+
end
|
255
|
+
@RequestId = params['RequestId']
|
256
|
+
end
|
257
|
+
end
|
258
|
+
|
197
259
|
# 授权出错信息
|
198
260
|
class AuthFailMessage < TencentCloud::Common::AbstractModel
|
199
261
|
# @param ProxyOrganizationOpenId: 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
|
@@ -517,6 +579,26 @@ module TencentCloud
|
|
517
579
|
end
|
518
580
|
end
|
519
581
|
|
582
|
+
# 动态签署2.0合同参与人信息
|
583
|
+
class ChannelArchiveDynamicApproverData < TencentCloud::Common::AbstractModel
|
584
|
+
# @param SignId: 签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。 可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。
|
585
|
+
# @type SignId: String
|
586
|
+
# @param RecipientId: 签署方角色编号,签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。 填写控件和签署控件都与特定的角色编号关联。
|
587
|
+
# @type RecipientId: String
|
588
|
+
|
589
|
+
attr_accessor :SignId, :RecipientId
|
590
|
+
|
591
|
+
def initialize(signid=nil, recipientid=nil)
|
592
|
+
@SignId = signid
|
593
|
+
@RecipientId = recipientid
|
594
|
+
end
|
595
|
+
|
596
|
+
def deserialize(params)
|
597
|
+
@SignId = params['SignId']
|
598
|
+
@RecipientId = params['RecipientId']
|
599
|
+
end
|
600
|
+
end
|
601
|
+
|
520
602
|
# ChannelBatchCancelFlows请求参数结构体
|
521
603
|
class ChannelBatchCancelFlowsRequest < TencentCloud::Common::AbstractModel
|
522
604
|
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
@@ -1163,10 +1245,16 @@ module TencentCloud
|
|
1163
1245
|
# 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
|
1164
1246
|
# 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
1165
1247
|
# @type AutoJumpBack: Boolean
|
1248
|
+
# @param UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
|
1249
|
+
|
1250
|
+
# 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
|
1166
1251
|
|
1167
|
-
|
1252
|
+
# 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
|
1253
|
+
# @type UrlUseEnv: String
|
1168
1254
|
|
1169
|
-
|
1255
|
+
attr_accessor :Agent, :Name, :Mobile, :Operator, :IdCardType, :IdCardNumber, :NotifyType, :FlowIds, :OrganizationName, :JumpToDetail, :FlowBatchUrlInfo, :OpenId, :OrganizationOpenId, :AutoJumpBack, :UrlUseEnv
|
1256
|
+
|
1257
|
+
def initialize(agent=nil, name=nil, mobile=nil, operator=nil, idcardtype=nil, idcardnumber=nil, notifytype=nil, flowids=nil, organizationname=nil, jumptodetail=nil, flowbatchurlinfo=nil, openid=nil, organizationopenid=nil, autojumpback=nil, urluseenv=nil)
|
1170
1258
|
@Agent = agent
|
1171
1259
|
@Name = name
|
1172
1260
|
@Mobile = mobile
|
@@ -1181,6 +1269,7 @@ module TencentCloud
|
|
1181
1269
|
@OpenId = openid
|
1182
1270
|
@OrganizationOpenId = organizationopenid
|
1183
1271
|
@AutoJumpBack = autojumpback
|
1272
|
+
@UrlUseEnv = urluseenv
|
1184
1273
|
end
|
1185
1274
|
|
1186
1275
|
def deserialize(params)
|
@@ -1207,6 +1296,7 @@ module TencentCloud
|
|
1207
1296
|
@OpenId = params['OpenId']
|
1208
1297
|
@OrganizationOpenId = params['OrganizationOpenId']
|
1209
1298
|
@AutoJumpBack = params['AutoJumpBack']
|
1299
|
+
@UrlUseEnv = params['UrlUseEnv']
|
1210
1300
|
end
|
1211
1301
|
end
|
1212
1302
|
|
@@ -1396,6 +1486,63 @@ module TencentCloud
|
|
1396
1486
|
end
|
1397
1487
|
end
|
1398
1488
|
|
1489
|
+
# ChannelCreateDynamicFlowApprover请求参数结构体
|
1490
|
+
class ChannelCreateDynamicFlowApproverRequest < TencentCloud::Common::AbstractModel
|
1491
|
+
# @param FillDynamicFlowList: 动态合同信息
|
1492
|
+
# @type FillDynamicFlowList: Array
|
1493
|
+
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证
|
1494
|
+
# @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
|
1495
|
+
|
1496
|
+
attr_accessor :FillDynamicFlowList, :Agent
|
1497
|
+
|
1498
|
+
def initialize(filldynamicflowlist=nil, agent=nil)
|
1499
|
+
@FillDynamicFlowList = filldynamicflowlist
|
1500
|
+
@Agent = agent
|
1501
|
+
end
|
1502
|
+
|
1503
|
+
def deserialize(params)
|
1504
|
+
unless params['FillDynamicFlowList'].nil?
|
1505
|
+
@FillDynamicFlowList = []
|
1506
|
+
params['FillDynamicFlowList'].each do |i|
|
1507
|
+
dynamicflowinfo_tmp = DynamicFlowInfo.new
|
1508
|
+
dynamicflowinfo_tmp.deserialize(i)
|
1509
|
+
@FillDynamicFlowList << dynamicflowinfo_tmp
|
1510
|
+
end
|
1511
|
+
end
|
1512
|
+
unless params['Agent'].nil?
|
1513
|
+
@Agent = Agent.new
|
1514
|
+
@Agent.deserialize(params['Agent'])
|
1515
|
+
end
|
1516
|
+
end
|
1517
|
+
end
|
1518
|
+
|
1519
|
+
# ChannelCreateDynamicFlowApprover返回参数结构体
|
1520
|
+
class ChannelCreateDynamicFlowApproverResponse < TencentCloud::Common::AbstractModel
|
1521
|
+
# @param DynamicFlowResultList: 动态合同补充结果列表
|
1522
|
+
# @type DynamicFlowResultList: Array
|
1523
|
+
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
1524
|
+
# @type RequestId: String
|
1525
|
+
|
1526
|
+
attr_accessor :DynamicFlowResultList, :RequestId
|
1527
|
+
|
1528
|
+
def initialize(dynamicflowresultlist=nil, requestid=nil)
|
1529
|
+
@DynamicFlowResultList = dynamicflowresultlist
|
1530
|
+
@RequestId = requestid
|
1531
|
+
end
|
1532
|
+
|
1533
|
+
def deserialize(params)
|
1534
|
+
unless params['DynamicFlowResultList'].nil?
|
1535
|
+
@DynamicFlowResultList = []
|
1536
|
+
params['DynamicFlowResultList'].each do |i|
|
1537
|
+
dynamicflowresult_tmp = DynamicFlowResult.new
|
1538
|
+
dynamicflowresult_tmp.deserialize(i)
|
1539
|
+
@DynamicFlowResultList << dynamicflowresult_tmp
|
1540
|
+
end
|
1541
|
+
end
|
1542
|
+
@RequestId = params['RequestId']
|
1543
|
+
end
|
1544
|
+
end
|
1545
|
+
|
1399
1546
|
# ChannelCreateEmbedWebUrl请求参数结构体
|
1400
1547
|
class ChannelCreateEmbedWebUrlRequest < TencentCloud::Common::AbstractModel
|
1401
1548
|
# @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
@@ -1710,15 +1857,19 @@ module TencentCloud
|
|
1710
1857
|
# <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
1711
1858
|
# 注: `此参数在NeedPreview 为true时有效`
|
1712
1859
|
# @type PreviewType: Integer
|
1860
|
+
# @param OpenDynamicFlow: 是否开启动态合同(动态签署人2.0)
|
1861
|
+
# <ul><li> **false** :(默认) 不开启动态合同(动态签署人2.0)</li>
|
1862
|
+
# <li> **true** :开启动态合同(动态签署人2.0),发起后可继续追加合同签署人</li></ul>
|
1863
|
+
# @type OpenDynamicFlow: Boolean
|
1713
1864
|
|
1714
|
-
attr_accessor :Agent, :FlowName, :FlowDescription, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :CcInfos, :CcNotifyType, :AutoSignScene, :Operator, :FlowDisplayType, :NeedPreview, :PreviewType
|
1865
|
+
attr_accessor :Agent, :FlowName, :FlowDescription, :FlowApprovers, :FileIds, :Components, :Deadline, :CallbackUrl, :Unordered, :FlowType, :CustomShowMap, :CustomerData, :NeedSignReview, :ApproverVerifyType, :SignBeanTag, :CcInfos, :CcNotifyType, :AutoSignScene, :Operator, :FlowDisplayType, :NeedPreview, :PreviewType, :OpenDynamicFlow
|
1715
1866
|
extend Gem::Deprecate
|
1716
1867
|
deprecate :CallbackUrl, :none, 2024, 12
|
1717
1868
|
deprecate :CallbackUrl=, :none, 2024, 12
|
1718
1869
|
deprecate :Operator, :none, 2024, 12
|
1719
1870
|
deprecate :Operator=, :none, 2024, 12
|
1720
1871
|
|
1721
|
-
def initialize(agent=nil, flowname=nil, flowdescription=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil, operator=nil, flowdisplaytype=nil, needpreview=nil, previewtype=nil)
|
1872
|
+
def initialize(agent=nil, flowname=nil, flowdescription=nil, flowapprovers=nil, fileids=nil, components=nil, deadline=nil, callbackurl=nil, unordered=nil, flowtype=nil, customshowmap=nil, customerdata=nil, needsignreview=nil, approververifytype=nil, signbeantag=nil, ccinfos=nil, ccnotifytype=nil, autosignscene=nil, operator=nil, flowdisplaytype=nil, needpreview=nil, previewtype=nil, opendynamicflow=nil)
|
1722
1873
|
@Agent = agent
|
1723
1874
|
@FlowName = flowname
|
1724
1875
|
@FlowDescription = flowdescription
|
@@ -1741,6 +1892,7 @@ module TencentCloud
|
|
1741
1892
|
@FlowDisplayType = flowdisplaytype
|
1742
1893
|
@NeedPreview = needpreview
|
1743
1894
|
@PreviewType = previewtype
|
1895
|
+
@OpenDynamicFlow = opendynamicflow
|
1744
1896
|
end
|
1745
1897
|
|
1746
1898
|
def deserialize(params)
|
@@ -1793,6 +1945,7 @@ module TencentCloud
|
|
1793
1945
|
@FlowDisplayType = params['FlowDisplayType']
|
1794
1946
|
@NeedPreview = params['NeedPreview']
|
1795
1947
|
@PreviewType = params['PreviewType']
|
1948
|
+
@OpenDynamicFlow = params['OpenDynamicFlow']
|
1796
1949
|
end
|
1797
1950
|
end
|
1798
1951
|
|
@@ -6801,13 +6954,20 @@ module TencentCloud
|
|
6801
6954
|
# @type RecipientIds: Array
|
6802
6955
|
# @param FlowGroupUrlInfo: 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
|
6803
6956
|
# @type FlowGroupUrlInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowGroupUrlInfo`
|
6957
|
+
# @param UrlUseEnv: 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
|
6804
6958
|
|
6805
|
-
|
6959
|
+
# 在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
|
6960
|
+
|
6961
|
+
# 参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
|
6962
|
+
|
6963
|
+
# @type UrlUseEnv: String
|
6964
|
+
|
6965
|
+
attr_accessor :Agent, :FlowIds, :FlowGroupId, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :IdCardType, :IdCardNumber, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :Hides, :RecipientIds, :FlowGroupUrlInfo, :UrlUseEnv
|
6806
6966
|
extend Gem::Deprecate
|
6807
6967
|
deprecate :Operator, :none, 2024, 12
|
6808
6968
|
deprecate :Operator=, :none, 2024, 12
|
6809
6969
|
|
6810
|
-
def initialize(agent=nil, flowids=nil, flowgroupid=nil, endpoint=nil, generatetype=nil, organizationname=nil, name=nil, mobile=nil, idcardtype=nil, idcardnumber=nil, organizationopenid=nil, openid=nil, autojumpback=nil, jumpurl=nil, operator=nil, hides=nil, recipientids=nil, flowgroupurlinfo=nil)
|
6970
|
+
def initialize(agent=nil, flowids=nil, flowgroupid=nil, endpoint=nil, generatetype=nil, organizationname=nil, name=nil, mobile=nil, idcardtype=nil, idcardnumber=nil, organizationopenid=nil, openid=nil, autojumpback=nil, jumpurl=nil, operator=nil, hides=nil, recipientids=nil, flowgroupurlinfo=nil, urluseenv=nil)
|
6811
6971
|
@Agent = agent
|
6812
6972
|
@FlowIds = flowids
|
6813
6973
|
@FlowGroupId = flowgroupid
|
@@ -6826,6 +6986,7 @@ module TencentCloud
|
|
6826
6986
|
@Hides = hides
|
6827
6987
|
@RecipientIds = recipientids
|
6828
6988
|
@FlowGroupUrlInfo = flowgroupurlinfo
|
6989
|
+
@UrlUseEnv = urluseenv
|
6829
6990
|
end
|
6830
6991
|
|
6831
6992
|
def deserialize(params)
|
@@ -6856,6 +7017,7 @@ module TencentCloud
|
|
6856
7017
|
@FlowGroupUrlInfo = FlowGroupUrlInfo.new
|
6857
7018
|
@FlowGroupUrlInfo.deserialize(params['FlowGroupUrlInfo'])
|
6858
7019
|
end
|
7020
|
+
@UrlUseEnv = params['UrlUseEnv']
|
6859
7021
|
end
|
6860
7022
|
end
|
6861
7023
|
|
@@ -7928,6 +8090,92 @@ module TencentCloud
|
|
7928
8090
|
end
|
7929
8091
|
end
|
7930
8092
|
|
8093
|
+
# 动态合同签署人结果
|
8094
|
+
class DynamicFlowApproverResult < TencentCloud::Common::AbstractModel
|
8095
|
+
# @param RecipientId: 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
8096
|
+
# @type RecipientId: String
|
8097
|
+
# @param SignId: 签署ID - 发起流程时系统自动补充 - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
8098
|
+
# @type SignId: String
|
8099
|
+
# @param ApproverStatus: 签署人状态信息
|
8100
|
+
# @type ApproverStatus: Integer
|
8101
|
+
|
8102
|
+
attr_accessor :RecipientId, :SignId, :ApproverStatus
|
8103
|
+
|
8104
|
+
def initialize(recipientid=nil, signid=nil, approverstatus=nil)
|
8105
|
+
@RecipientId = recipientid
|
8106
|
+
@SignId = signid
|
8107
|
+
@ApproverStatus = approverstatus
|
8108
|
+
end
|
8109
|
+
|
8110
|
+
def deserialize(params)
|
8111
|
+
@RecipientId = params['RecipientId']
|
8112
|
+
@SignId = params['SignId']
|
8113
|
+
@ApproverStatus = params['ApproverStatus']
|
8114
|
+
end
|
8115
|
+
end
|
8116
|
+
|
8117
|
+
# 动态合同信息
|
8118
|
+
class DynamicFlowInfo < TencentCloud::Common::AbstractModel
|
8119
|
+
# @param FlowId: 合同流程ID,为32位字符串。 - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 - 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color="red">不建议继续使用</font>,请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
|
8120
|
+
# @type FlowId: String
|
8121
|
+
# @param FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
|
8122
|
+
# @type FlowApprovers: Array
|
8123
|
+
# @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传: <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
8124
|
+
# @type AutoSignScene: String
|
8125
|
+
# @param ApproverVerifyType: 签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
8126
|
+
# @type ApproverVerifyType: String
|
8127
|
+
|
8128
|
+
attr_accessor :FlowId, :FlowApprovers, :AutoSignScene, :ApproverVerifyType
|
8129
|
+
|
8130
|
+
def initialize(flowid=nil, flowapprovers=nil, autosignscene=nil, approververifytype=nil)
|
8131
|
+
@FlowId = flowid
|
8132
|
+
@FlowApprovers = flowapprovers
|
8133
|
+
@AutoSignScene = autosignscene
|
8134
|
+
@ApproverVerifyType = approververifytype
|
8135
|
+
end
|
8136
|
+
|
8137
|
+
def deserialize(params)
|
8138
|
+
@FlowId = params['FlowId']
|
8139
|
+
unless params['FlowApprovers'].nil?
|
8140
|
+
@FlowApprovers = []
|
8141
|
+
params['FlowApprovers'].each do |i|
|
8142
|
+
flowapproverinfo_tmp = FlowApproverInfo.new
|
8143
|
+
flowapproverinfo_tmp.deserialize(i)
|
8144
|
+
@FlowApprovers << flowapproverinfo_tmp
|
8145
|
+
end
|
8146
|
+
end
|
8147
|
+
@AutoSignScene = params['AutoSignScene']
|
8148
|
+
@ApproverVerifyType = params['ApproverVerifyType']
|
8149
|
+
end
|
8150
|
+
end
|
8151
|
+
|
8152
|
+
# 动态合同补充签署人结果
|
8153
|
+
class DynamicFlowResult < TencentCloud::Common::AbstractModel
|
8154
|
+
# @param FlowId: 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
|
8155
|
+
# @type FlowId: String
|
8156
|
+
# @param DynamicFlowApproverList: 动态合同签署人补充结果信息列表
|
8157
|
+
# @type DynamicFlowApproverList: Array
|
8158
|
+
|
8159
|
+
attr_accessor :FlowId, :DynamicFlowApproverList
|
8160
|
+
|
8161
|
+
def initialize(flowid=nil, dynamicflowapproverlist=nil)
|
8162
|
+
@FlowId = flowid
|
8163
|
+
@DynamicFlowApproverList = dynamicflowapproverlist
|
8164
|
+
end
|
8165
|
+
|
8166
|
+
def deserialize(params)
|
8167
|
+
@FlowId = params['FlowId']
|
8168
|
+
unless params['DynamicFlowApproverList'].nil?
|
8169
|
+
@DynamicFlowApproverList = []
|
8170
|
+
params['DynamicFlowApproverList'].each do |i|
|
8171
|
+
dynamicflowapproverresult_tmp = DynamicFlowApproverResult.new
|
8172
|
+
dynamicflowapproverresult_tmp.deserialize(i)
|
8173
|
+
@DynamicFlowApproverList << dynamicflowapproverresult_tmp
|
8174
|
+
end
|
8175
|
+
end
|
8176
|
+
end
|
8177
|
+
end
|
8178
|
+
|
7931
8179
|
# 创建嵌入式页面url个性化参数
|
7932
8180
|
class EmbedUrlOption < TencentCloud::Common::AbstractModel
|
7933
8181
|
# @param ShowFlowDetailComponent: 合同详情预览,允许展示控件信息
|
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.969
|
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-12-
|
11
|
+
date: 2024-12-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|