tencentcloud-sdk-ess 3.0.652 → 3.0.654
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/v20201111/client.rb +46 -24
- data/lib/v20201111/models.rb +239 -158
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 90650f8b1eec263cc67d24f0ff357e4cd2e016f6
|
4
|
+
data.tar.gz: a10db0ff77eafecbfc95fa7c8466d39f31c493fd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e4955ae8ef02e37a87975f409f59069096d1ecce298865676a6dcbad63b72c3260b762b042dd2985a6e91a2e893afe3a25cb4b8c4f629e0dc5a1af6af5b51944
|
7
|
+
data.tar.gz: 657cd55f59e9f092da384a2389af53f733a94d74645ecfadba743d4470add5d96e1ba6174a2fb04a698f1be2ce72f5b117a69ea633278bffcf37a3d7f17cff01
|
data/lib/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.654
|
data/lib/v20201111/client.rb
CHANGED
@@ -53,9 +53,9 @@ module TencentCloud
|
|
53
53
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
54
54
|
end
|
55
55
|
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
56
|
+
# 用于撤销签署流程<br/>
|
57
|
+
# 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
|
58
|
+
# `注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`
|
59
59
|
|
60
60
|
# @param request: Request instance for CancelFlow.
|
61
61
|
# @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
|
@@ -79,7 +79,9 @@ module TencentCloud
|
|
79
79
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
80
80
|
end
|
81
81
|
|
82
|
-
# 此接口(CancelMultiFlowSignQRCode
|
82
|
+
# 此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
|
83
|
+
# 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
|
84
|
+
# 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
|
83
85
|
|
84
86
|
# @param request: Request instance for CancelMultiFlowSignQRCode.
|
85
87
|
# @type request: :class:`Tencentcloud::ess::V20201111::CancelMultiFlowSignQRCodeRequest`
|
@@ -105,6 +107,8 @@ module TencentCloud
|
|
105
107
|
|
106
108
|
# 此接口(CancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)
|
107
109
|
|
110
|
+
# 注: `在调用此接口时,请确保指定的用户已生成自动签开通链接并且未完成开通,否则无法撤销`
|
111
|
+
|
108
112
|
# @param request: Request instance for CancelUserAutoSignEnableUrl.
|
109
113
|
# @type request: :class:`Tencentcloud::ess::V20201111::CancelUserAutoSignEnableUrlRequest`
|
110
114
|
# @rtype: :class:`Tencentcloud::ess::V20201111::CancelUserAutoSignEnableUrlResponse`
|
@@ -474,13 +478,12 @@ module TencentCloud
|
|
474
478
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
475
479
|
end
|
476
480
|
|
477
|
-
#
|
478
|
-
|
479
|
-
# 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
|
481
|
+
# 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
|
480
482
|
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
483
|
+
# 注:
|
484
|
+
# `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)`
|
485
|
+
# `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 `
|
486
|
+
# `3. 该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。跳转到小程序的实现,参考微信官方文档(分为<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>
|
484
487
|
|
485
488
|
# @param request: Request instance for CreateFlowSignUrl.
|
486
489
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignUrlRequest`
|
@@ -611,7 +614,8 @@ module TencentCloud
|
|
611
614
|
end
|
612
615
|
|
613
616
|
# 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
614
|
-
# 适用场景:无需填写签署人信息,可通过模板id
|
617
|
+
# 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
|
618
|
+
# 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
615
619
|
|
616
620
|
# **本接口适用于发起方没有填写控件的 B2C或者单C模板**
|
617
621
|
|
@@ -747,6 +751,13 @@ module TencentCloud
|
|
747
751
|
|
748
752
|
# 发起解除协议,主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
749
753
|
|
754
|
+
# `注意:原合同必须签署完成后,才能发起解除协议。` <br/>
|
755
|
+
# `注意:只有原合同企业类型的参与人才能发起解除协议,个人不能发起解除协议。`<br/>
|
756
|
+
# `注意:原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人参与解除协议。`<br/>
|
757
|
+
# `注意:如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理。`<br/>
|
758
|
+
# `注意:发起解除协议同发起其他企业合同一样,也会参与合同扣费,扣费标准同其他类型合同。`<br/>
|
759
|
+
# `注意:在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均会转变为已解除状态。`<br/>
|
760
|
+
|
750
761
|
# @param request: Request instance for CreateReleaseFlow.
|
751
762
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowRequest`
|
752
763
|
# @rtype: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowResponse`
|
@@ -769,17 +780,22 @@ module TencentCloud
|
|
769
780
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
770
781
|
end
|
771
782
|
|
772
|
-
#
|
783
|
+
# 获取跳转至腾讯电子签小程序的签署链接
|
773
784
|
|
774
785
|
# 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
775
786
|
|
776
|
-
#
|
787
|
+
# 跳转到小程序的实现,参考微信官方文档(分为<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>
|
777
788
|
|
789
|
+
# 注:
|
790
|
+
# `1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署`
|
791
|
+
# `2. 签署链接的有效期为90天,超过有效期链接不可用`
|
778
792
|
|
779
|
-
#
|
793
|
+
# 其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
780
794
|
|
781
|
-
|
782
|
-
#
|
795
|
+
# | 小程序 | AppID | 原始ID |
|
796
|
+
# | ------------ | ------------ | ------------ |
|
797
|
+
# | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
798
|
+
# | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
783
799
|
|
784
800
|
# @param request: Request instance for CreateSchemeUrl.
|
785
801
|
# @type request: :class:`Tencentcloud::ess::V20201111::CreateSchemeUrlRequest`
|
@@ -998,7 +1014,12 @@ module TencentCloud
|
|
998
1014
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
999
1015
|
end
|
1000
1016
|
|
1001
|
-
#
|
1017
|
+
# 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
|
1018
|
+
# 1. 企业静默签
|
1019
|
+
# 2. 企业与港澳台居民签署合同
|
1020
|
+
# 3. 使用手机号验证签署方身份
|
1021
|
+
# 4. 骑缝章
|
1022
|
+
# 5. 批量签署能力
|
1002
1023
|
|
1003
1024
|
# @param request: Request instance for DescribeExtendedServiceAuthInfos.
|
1004
1025
|
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeExtendedServiceAuthInfosRequest`
|
@@ -1097,7 +1118,7 @@ module TencentCloud
|
|
1097
1118
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1098
1119
|
end
|
1099
1120
|
|
1100
|
-
#
|
1121
|
+
# 查询签署报告,返回报告 URL。需调用创建并返回出证报告接口(CreateFlowEvidenceReport)获取报告编号后调用当前接口获取报告链接。
|
1101
1122
|
|
1102
1123
|
# @param request: Request instance for DescribeFlowEvidenceReport.
|
1103
1124
|
# @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowEvidenceReportRequest`
|
@@ -1426,9 +1447,10 @@ module TencentCloud
|
|
1426
1447
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1427
1448
|
end
|
1428
1449
|
|
1429
|
-
#
|
1430
|
-
#
|
1431
|
-
#
|
1450
|
+
# 新增/删除企业应用集成中的回调配置。
|
1451
|
+
# 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
|
1452
|
+
# 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
1453
|
+
# 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
|
1432
1454
|
|
1433
1455
|
# @param request: Request instance for ModifyApplicationCallbackInfo.
|
1434
1456
|
# @type request: :class:`Tencentcloud::ess::V20201111::ModifyApplicationCallbackInfoRequest`
|
@@ -1509,9 +1531,9 @@ module TencentCloud
|
|
1509
1531
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
1510
1532
|
end
|
1511
1533
|
|
1512
|
-
#
|
1513
|
-
#
|
1514
|
-
#
|
1534
|
+
# 此接口用于启动流程。它是模板发起合同的最后一步。
|
1535
|
+
# 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于激活包含完整合同信息(模板及内容信息)的流程。
|
1536
|
+
# 流程激活后,将生成一份待签署的电子合同。
|
1515
1537
|
|
1516
1538
|
# @param request: Request instance for StartFlow.
|
1517
1539
|
# @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`
|
data/lib/v20201111/models.rb
CHANGED
@@ -415,15 +415,15 @@ module TencentCloud
|
|
415
415
|
end
|
416
416
|
end
|
417
417
|
|
418
|
-
#
|
418
|
+
# 企业应用回调信息
|
419
419
|
class CallbackInfo < TencentCloud::Common::AbstractModel
|
420
|
-
# @param CallbackUrl: 回调url
|
420
|
+
# @param CallbackUrl: 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
421
421
|
# @type CallbackUrl: String
|
422
422
|
# @param Token: 回调加密key,已废弃
|
423
423
|
# @type Token: String
|
424
|
-
# @param CallbackKey: 回调加密key
|
424
|
+
# @param CallbackKey: 回调加密key,用于回调消息加解密。
|
425
425
|
# @type CallbackKey: String
|
426
|
-
# @param CallbackToken: 回调验签token
|
426
|
+
# @param CallbackToken: 回调验签token,用于回调通知校验。
|
427
427
|
# @type CallbackToken: String
|
428
428
|
|
429
429
|
attr_accessor :CallbackUrl, :Token, :CallbackKey, :CallbackToken
|
@@ -483,13 +483,16 @@ module TencentCloud
|
|
483
483
|
|
484
484
|
# CancelFlow请求参数结构体
|
485
485
|
class CancelFlowRequest < TencentCloud::Common::AbstractModel
|
486
|
-
# @param Operator:
|
486
|
+
# @param Operator: 执行本接口操作的员工信息。
|
487
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
487
488
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
488
|
-
# @param FlowId:
|
489
|
+
# @param FlowId: 合同流程ID, 为32位字符串。
|
490
|
+
# 建议开发者保存此流程ID方便后续其他操作。
|
489
491
|
# @type FlowId: String
|
490
|
-
# @param CancelMessage:
|
492
|
+
# @param CancelMessage: 撤销此合同(流程)的原因,最长200个字。
|
491
493
|
# @type CancelMessage: String
|
492
|
-
# @param Agent:
|
494
|
+
# @param Agent: 代理企业和员工的信息。
|
495
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
493
496
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
494
497
|
|
495
498
|
attr_accessor :Operator, :FlowId, :CancelMessage, :Agent
|
@@ -533,11 +536,13 @@ module TencentCloud
|
|
533
536
|
|
534
537
|
# CancelMultiFlowSignQRCode请求参数结构体
|
535
538
|
class CancelMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
|
536
|
-
# @param Operator:
|
539
|
+
# @param Operator: 执行本接口操作的员工信息。
|
540
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
537
541
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
538
|
-
# @param QrCodeId: 二维码
|
542
|
+
# @param QrCodeId: 二维码ID,为32位字符串。
|
539
543
|
# @type QrCodeId: String
|
540
|
-
# @param Agent:
|
544
|
+
# @param Agent: 代理企业和员工的信息。
|
545
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
541
546
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
542
547
|
|
543
548
|
attr_accessor :Operator, :QrCodeId, :Agent
|
@@ -579,19 +584,27 @@ module TencentCloud
|
|
579
584
|
|
580
585
|
# CancelUserAutoSignEnableUrl请求参数结构体
|
581
586
|
class CancelUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
|
582
|
-
# @param Operator:
|
587
|
+
# @param Operator: 执行本接口操作的员工信息。
|
588
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
583
589
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
584
|
-
# @param SceneKey:
|
590
|
+
# @param SceneKey: 企业开通用户自动签场景,例如电子处方。
|
591
|
+
# <ul>
|
592
|
+
# <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
|
593
|
+
# </ul>
|
585
594
|
# @type SceneKey: String
|
586
595
|
# @param UserInfo: 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
|
587
596
|
# @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
|
597
|
+
# @param Agent: 代理企业和员工的信息。
|
598
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
599
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
588
600
|
|
589
|
-
attr_accessor :Operator, :SceneKey, :UserInfo
|
601
|
+
attr_accessor :Operator, :SceneKey, :UserInfo, :Agent
|
590
602
|
|
591
|
-
def initialize(operator=nil, scenekey=nil, userinfo=nil)
|
603
|
+
def initialize(operator=nil, scenekey=nil, userinfo=nil, agent=nil)
|
592
604
|
@Operator = operator
|
593
605
|
@SceneKey = scenekey
|
594
606
|
@UserInfo = userinfo
|
607
|
+
@Agent = agent
|
595
608
|
end
|
596
609
|
|
597
610
|
def deserialize(params)
|
@@ -604,6 +617,10 @@ module TencentCloud
|
|
604
617
|
@UserInfo = UserThreeFactor.new
|
605
618
|
@UserInfo.deserialize(params['UserInfo'])
|
606
619
|
end
|
620
|
+
unless params['Agent'].nil?
|
621
|
+
@Agent = Agent.new
|
622
|
+
@Agent.deserialize(params['Agent'])
|
623
|
+
end
|
607
624
|
end
|
608
625
|
end
|
609
626
|
|
@@ -2107,19 +2124,25 @@ module TencentCloud
|
|
2107
2124
|
|
2108
2125
|
# CreateFlowSignUrl请求参数结构体
|
2109
2126
|
class CreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
|
2110
|
-
# @param FlowId:
|
2127
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
2128
|
+
# 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
2129
|
+
# 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
2111
2130
|
# @type FlowId: String
|
2112
|
-
# @param FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
2131
|
+
# @param FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
2113
2132
|
|
2114
|
-
#
|
2133
|
+
# 注:
|
2134
|
+
# `1. ApproverType目前只支持个人类型的签署人。`
|
2135
|
+
# `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
2115
2136
|
# @type FlowApproverInfos: Array
|
2116
|
-
# @param Operator:
|
2137
|
+
# @param Operator: 执行本接口操作的员工信息。
|
2138
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
2117
2139
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
2118
|
-
# @param Agent:
|
2140
|
+
# @param Agent: 代理企业和员工的信息。
|
2141
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
2119
2142
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
2120
2143
|
# @param Organization: 机构信息,暂未开放
|
2121
2144
|
# @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
|
2122
|
-
# @param JumpUrl: 签署完之后的H5
|
2145
|
+
# @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
2123
2146
|
# @type JumpUrl: String
|
2124
2147
|
|
2125
2148
|
attr_accessor :FlowId, :FlowApproverInfos, :Operator, :Agent, :Organization, :JumpUrl
|
@@ -2460,50 +2483,56 @@ module TencentCloud
|
|
2460
2483
|
|
2461
2484
|
# CreateMultiFlowSignQRCode请求参数结构体
|
2462
2485
|
class CreateMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
|
2463
|
-
# @param Operator:
|
2486
|
+
# @param Operator: 执行本接口操作的员工信息。
|
2487
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
2464
2488
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
2465
|
-
# @param TemplateId:
|
2489
|
+
# @param TemplateId: 合同模板ID,为32位字符串。
|
2490
|
+
# 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
2466
2491
|
# @type TemplateId: String
|
2467
|
-
# @param FlowName:
|
2492
|
+
# @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
2493
|
+
# 该名称还将用于合同签署完成后的下载文件名。
|
2468
2494
|
# @type FlowName: String
|
2469
|
-
# @param MaxFlowNum:
|
2470
|
-
#
|
2495
|
+
# @param MaxFlowNum: 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。
|
2496
|
+
# 一旦发起流程数超越该限制,该二维码将自动失效。
|
2471
2497
|
# @type MaxFlowNum: Integer
|
2472
|
-
# @param
|
2473
|
-
#
|
2474
|
-
# <br/>最高设置不超过30天
|
2475
|
-
# @type FlowEffectiveDay: Integer
|
2476
|
-
# @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
|
2498
|
+
# @param QrEffectiveDay: 二维码的有效期限,默认为7天,最高设定不得超过90天。
|
2499
|
+
# 一旦超过二维码的有效期限,该二维码将自动失效。
|
2477
2500
|
# @type QrEffectiveDay: Integer
|
2478
|
-
# @param
|
2479
|
-
#
|
2501
|
+
# @param FlowEffectiveDay: 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。
|
2502
|
+
# 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。
|
2503
|
+
# 最长设定期限不得超过30天。
|
2504
|
+
# @type FlowEffectiveDay: Integer
|
2505
|
+
# @param Restrictions: 指定签署人信息。
|
2506
|
+
# 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
|
2480
2507
|
# @type Restrictions: Array
|
2481
|
-
# @param UserData:
|
2482
|
-
#
|
2508
|
+
# @param UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
|
2509
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
2510
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
2483
2511
|
# @type UserData: String
|
2484
2512
|
# @param CallbackUrl: 已废弃,回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
|
2485
2513
|
# <br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
|
2486
2514
|
# <br/> 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83
|
2487
2515
|
# @type CallbackUrl: String
|
2488
|
-
# @param Agent:
|
2516
|
+
# @param Agent: 代理企业和员工的信息。
|
2517
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
2489
2518
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
2490
2519
|
# @param ApproverRestrictions: 限制二维码用户条件(已弃用)
|
2491
2520
|
# @type ApproverRestrictions: :class:`Tencentcloud::Ess.v20201111.models.ApproverRestriction`
|
2492
2521
|
|
2493
|
-
attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :
|
2522
|
+
attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :QrEffectiveDay, :FlowEffectiveDay, :Restrictions, :UserData, :CallbackUrl, :Agent, :ApproverRestrictions
|
2494
2523
|
extend Gem::Deprecate
|
2495
2524
|
deprecate :CallbackUrl, :none, 2023, 9
|
2496
2525
|
deprecate :CallbackUrl=, :none, 2023, 9
|
2497
2526
|
deprecate :ApproverRestrictions, :none, 2023, 9
|
2498
2527
|
deprecate :ApproverRestrictions=, :none, 2023, 9
|
2499
2528
|
|
2500
|
-
def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil,
|
2529
|
+
def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil, qreffectiveday=nil, floweffectiveday=nil, restrictions=nil, userdata=nil, callbackurl=nil, agent=nil, approverrestrictions=nil)
|
2501
2530
|
@Operator = operator
|
2502
2531
|
@TemplateId = templateid
|
2503
2532
|
@FlowName = flowname
|
2504
2533
|
@MaxFlowNum = maxflownum
|
2505
|
-
@FlowEffectiveDay = floweffectiveday
|
2506
2534
|
@QrEffectiveDay = qreffectiveday
|
2535
|
+
@FlowEffectiveDay = floweffectiveday
|
2507
2536
|
@Restrictions = restrictions
|
2508
2537
|
@UserData = userdata
|
2509
2538
|
@CallbackUrl = callbackurl
|
@@ -2519,8 +2548,8 @@ module TencentCloud
|
|
2519
2548
|
@TemplateId = params['TemplateId']
|
2520
2549
|
@FlowName = params['FlowName']
|
2521
2550
|
@MaxFlowNum = params['MaxFlowNum']
|
2522
|
-
@FlowEffectiveDay = params['FlowEffectiveDay']
|
2523
2551
|
@QrEffectiveDay = params['QrEffectiveDay']
|
2552
|
+
@FlowEffectiveDay = params['FlowEffectiveDay']
|
2524
2553
|
unless params['Restrictions'].nil?
|
2525
2554
|
@Restrictions = []
|
2526
2555
|
params['Restrictions'].each do |i|
|
@@ -2544,9 +2573,9 @@ module TencentCloud
|
|
2544
2573
|
|
2545
2574
|
# CreateMultiFlowSignQRCode返回参数结构体
|
2546
2575
|
class CreateMultiFlowSignQRCodeResponse < TencentCloud::Common::AbstractModel
|
2547
|
-
# @param QrCode:
|
2576
|
+
# @param QrCode: 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
|
2548
2577
|
# @type QrCode: :class:`Tencentcloud::Ess.v20201111.models.SignQrCode`
|
2549
|
-
# @param SignUrls:
|
2578
|
+
# @param SignUrls: 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
|
2550
2579
|
# @type SignUrls: :class:`Tencentcloud::Ess.v20201111.models.SignUrl`
|
2551
2580
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
2552
2581
|
# @type RequestId: String
|
@@ -2979,30 +3008,40 @@ module TencentCloud
|
|
2979
3008
|
|
2980
3009
|
# CreateReleaseFlow请求参数结构体
|
2981
3010
|
class CreateReleaseFlowRequest < TencentCloud::Common::AbstractModel
|
2982
|
-
# @param Operator:
|
3011
|
+
# @param Operator: 执行本接口操作的员工信息。
|
3012
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
2983
3013
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
2984
|
-
# @param NeedRelievedFlowId:
|
3014
|
+
# @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
|
2985
3015
|
# @type NeedRelievedFlowId: String
|
2986
|
-
# @param ReliveInfo:
|
3016
|
+
# @param ReliveInfo: 解除协议内容。
|
2987
3017
|
# @type ReliveInfo: :class:`Tencentcloud::Ess.v20201111.models.RelieveInfo`
|
2988
|
-
# @param
|
2989
|
-
#
|
2990
|
-
#
|
3018
|
+
# @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
3019
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3020
|
+
# @param ReleasedApprovers: 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
|
3021
|
+
# 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
3022
|
+
# 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
|
3023
|
+
|
3024
|
+
# `注意:只能更换同企业的签署人。`<br/>
|
3025
|
+
# `注意:不支持更换个人类型的签署人。`<br/>
|
2991
3026
|
# @type ReleasedApprovers: Array
|
2992
|
-
# @param Deadline:
|
3027
|
+
# @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
|
3028
|
+
# 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
2993
3029
|
# @type Deadline: Integer
|
2994
|
-
# @param
|
2995
|
-
#
|
3030
|
+
# @param UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
|
3031
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
3032
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
3033
|
+
# @type UserData: String
|
2996
3034
|
|
2997
|
-
attr_accessor :Operator, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :Deadline, :
|
3035
|
+
attr_accessor :Operator, :NeedRelievedFlowId, :ReliveInfo, :Agent, :ReleasedApprovers, :Deadline, :UserData
|
2998
3036
|
|
2999
|
-
def initialize(operator=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, deadline=nil,
|
3037
|
+
def initialize(operator=nil, needrelievedflowid=nil, reliveinfo=nil, agent=nil, releasedapprovers=nil, deadline=nil, userdata=nil)
|
3000
3038
|
@Operator = operator
|
3001
3039
|
@NeedRelievedFlowId = needrelievedflowid
|
3002
3040
|
@ReliveInfo = reliveinfo
|
3041
|
+
@Agent = agent
|
3003
3042
|
@ReleasedApprovers = releasedapprovers
|
3004
3043
|
@Deadline = deadline
|
3005
|
-
@
|
3044
|
+
@UserData = userdata
|
3006
3045
|
end
|
3007
3046
|
|
3008
3047
|
def deserialize(params)
|
@@ -3015,6 +3054,10 @@ module TencentCloud
|
|
3015
3054
|
@ReliveInfo = RelieveInfo.new
|
3016
3055
|
@ReliveInfo.deserialize(params['ReliveInfo'])
|
3017
3056
|
end
|
3057
|
+
unless params['Agent'].nil?
|
3058
|
+
@Agent = Agent.new
|
3059
|
+
@Agent.deserialize(params['Agent'])
|
3060
|
+
end
|
3018
3061
|
unless params['ReleasedApprovers'].nil?
|
3019
3062
|
@ReleasedApprovers = []
|
3020
3063
|
params['ReleasedApprovers'].each do |i|
|
@@ -3024,16 +3067,14 @@ module TencentCloud
|
|
3024
3067
|
end
|
3025
3068
|
end
|
3026
3069
|
@Deadline = params['Deadline']
|
3027
|
-
|
3028
|
-
@Agent = Agent.new
|
3029
|
-
@Agent.deserialize(params['Agent'])
|
3030
|
-
end
|
3070
|
+
@UserData = params['UserData']
|
3031
3071
|
end
|
3032
3072
|
end
|
3033
3073
|
|
3034
3074
|
# CreateReleaseFlow返回参数结构体
|
3035
3075
|
class CreateReleaseFlowResponse < TencentCloud::Common::AbstractModel
|
3036
3076
|
# @param FlowId: 解除协议流程编号
|
3077
|
+
# `注意:这里的流程编号对应的合同是本次发起的解除协议。`
|
3037
3078
|
# @type FlowId: String
|
3038
3079
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3039
3080
|
# @type RequestId: String
|
@@ -3053,43 +3094,48 @@ module TencentCloud
|
|
3053
3094
|
|
3054
3095
|
# CreateSchemeUrl请求参数结构体
|
3055
3096
|
class CreateSchemeUrlRequest < TencentCloud::Common::AbstractModel
|
3056
|
-
# @param Operator:
|
3097
|
+
# @param Operator: 执行本接口操作的员工信息, userId 必填。
|
3098
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3057
3099
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3058
|
-
# @param OrganizationName:
|
3100
|
+
# @param OrganizationName: 合同流程签署方的组织机构名称。
|
3101
|
+
# 如果名称中包含英文括号(),请使用中文括号()代替。
|
3059
3102
|
# @type OrganizationName: String
|
3060
|
-
# @param Name:
|
3103
|
+
# @param Name: 合同流程里边签署方经办人的姓名。
|
3061
3104
|
# @type Name: String
|
3062
|
-
# @param Mobile:
|
3105
|
+
# @param Mobile: 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
3063
3106
|
# @type Mobile: String
|
3064
3107
|
# @param EndPoint: 要跳转的链接类型
|
3065
3108
|
|
3066
|
-
#
|
3067
|
-
#
|
3068
|
-
#
|
3109
|
+
# <ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li>
|
3110
|
+
# <li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li>
|
3111
|
+
# <li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li></ul>
|
3069
3112
|
# @type EndPoint: String
|
3070
|
-
# @param FlowId:
|
3113
|
+
# @param FlowId: 合同流程ID
|
3114
|
+
# 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
|
3071
3115
|
# @type FlowId: String
|
3072
|
-
# @param FlowGroupId:
|
3116
|
+
# @param FlowGroupId: 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
|
3073
3117
|
# @type FlowGroupId: String
|
3074
3118
|
# @param PathType: 要跳转到的页面类型
|
3075
3119
|
|
3076
|
-
#
|
3077
|
-
#
|
3078
|
-
#
|
3120
|
+
# <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
|
3121
|
+
# <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
|
3122
|
+
# <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
|
3079
3123
|
# @type PathType: Integer
|
3080
|
-
# @param AutoJumpBack:
|
3081
|
-
# true
|
3082
|
-
#
|
3083
|
-
# 该参数只针对"APP" 类型的签署链接有效
|
3124
|
+
# @param AutoJumpBack: 签署完成后是否自动回跳
|
3125
|
+
# <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
|
3126
|
+
# 注: ` 该参数只针对"APP" 类型的签署链接有效`
|
3084
3127
|
# @type AutoJumpBack: Boolean
|
3085
|
-
# @param Agent:
|
3128
|
+
# @param Agent: 代理企业和员工的信息。
|
3129
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3086
3130
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3087
|
-
# @param Hides:
|
3131
|
+
# @param Hides: 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
|
3088
3132
|
|
3089
|
-
#
|
3090
|
-
#
|
3091
|
-
#
|
3092
|
-
#
|
3133
|
+
# <ul><li> **0** :合同签署页面更多操作按钮</li>
|
3134
|
+
# <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
|
3135
|
+
# <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
|
3136
|
+
# <li> **3** :签署成功页的查看详情按钮</li></ul>
|
3137
|
+
|
3138
|
+
# 注: `字段为数组, 可以传值隐藏多个按钮`
|
3093
3139
|
# @type Hides: Array
|
3094
3140
|
|
3095
3141
|
attr_accessor :Operator, :OrganizationName, :Name, :Mobile, :EndPoint, :FlowId, :FlowGroupId, :PathType, :AutoJumpBack, :Agent, :Hides
|
@@ -3131,7 +3177,11 @@ module TencentCloud
|
|
3131
3177
|
|
3132
3178
|
# CreateSchemeUrl返回参数结构体
|
3133
3179
|
class CreateSchemeUrlResponse < TencentCloud::Common::AbstractModel
|
3134
|
-
# @param SchemeUrl:
|
3180
|
+
# @param SchemeUrl: 腾讯电子签小程序的签署链接。
|
3181
|
+
|
3182
|
+
# <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
|
3183
|
+
# <li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
|
3184
|
+
# <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
|
3135
3185
|
# @type SchemeUrl: String
|
3136
3186
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3137
3187
|
# @type RequestId: String
|
@@ -3819,24 +3869,28 @@ module TencentCloud
|
|
3819
3869
|
|
3820
3870
|
# DescribeExtendedServiceAuthInfos请求参数结构体
|
3821
3871
|
class DescribeExtendedServiceAuthInfosRequest < TencentCloud::Common::AbstractModel
|
3822
|
-
# @param Operator:
|
3872
|
+
# @param Operator: 执行本接口操作的员工信息。
|
3873
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3823
3874
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3824
|
-
# @param
|
3825
|
-
#
|
3826
|
-
#
|
3827
|
-
# OPEN_SERVER_SIGN
|
3828
|
-
# OVERSEA_SIGN
|
3829
|
-
# MOBILE_CHECK_APPROVER
|
3830
|
-
# PAGING_SEAL
|
3831
|
-
# BATCH_SIGN
|
3875
|
+
# @param ExtendServiceType: 要查询的扩展服务类型。
|
3876
|
+
# 默认为空,即查询当前支持的所有扩展服务信息。
|
3877
|
+
# 若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
|
3878
|
+
# <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
|
3879
|
+
# <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
|
3880
|
+
# <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
|
3881
|
+
# <li>PAGING_SEAL:骑缝章</li>
|
3882
|
+
# <li>BATCH_SIGN:批量签署</li></ul>
|
3832
3883
|
# @type ExtendServiceType: String
|
3884
|
+
# @param Agent: 代理企业和员工的信息。
|
3885
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3886
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3833
3887
|
|
3834
|
-
attr_accessor :Operator, :
|
3888
|
+
attr_accessor :Operator, :ExtendServiceType, :Agent
|
3835
3889
|
|
3836
|
-
def initialize(operator=nil,
|
3890
|
+
def initialize(operator=nil, extendservicetype=nil, agent=nil)
|
3837
3891
|
@Operator = operator
|
3838
|
-
@Agent = agent
|
3839
3892
|
@ExtendServiceType = extendservicetype
|
3893
|
+
@Agent = agent
|
3840
3894
|
end
|
3841
3895
|
|
3842
3896
|
def deserialize(params)
|
@@ -3844,17 +3898,17 @@ module TencentCloud
|
|
3844
3898
|
@Operator = UserInfo.new
|
3845
3899
|
@Operator.deserialize(params['Operator'])
|
3846
3900
|
end
|
3901
|
+
@ExtendServiceType = params['ExtendServiceType']
|
3847
3902
|
unless params['Agent'].nil?
|
3848
3903
|
@Agent = Agent.new
|
3849
3904
|
@Agent.deserialize(params['Agent'])
|
3850
3905
|
end
|
3851
|
-
@ExtendServiceType = params['ExtendServiceType']
|
3852
3906
|
end
|
3853
3907
|
end
|
3854
3908
|
|
3855
3909
|
# DescribeExtendedServiceAuthInfos返回参数结构体
|
3856
3910
|
class DescribeExtendedServiceAuthInfosResponse < TencentCloud::Common::AbstractModel
|
3857
|
-
# @param AuthInfoList:
|
3911
|
+
# @param AuthInfoList: 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
|
3858
3912
|
# @type AuthInfoList: Array
|
3859
3913
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3860
3914
|
# @type RequestId: String
|
@@ -4101,11 +4155,13 @@ module TencentCloud
|
|
4101
4155
|
|
4102
4156
|
# DescribeFlowEvidenceReport请求参数结构体
|
4103
4157
|
class DescribeFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
|
4104
|
-
# @param Operator:
|
4158
|
+
# @param Operator: 执行本接口操作的员工信息。
|
4159
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4105
4160
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4106
|
-
# @param ReportId:
|
4161
|
+
# @param ReportId: 签署报告编号
|
4107
4162
|
# @type ReportId: String
|
4108
|
-
# @param Agent:
|
4163
|
+
# @param Agent: 代理企业和员工的信息。
|
4164
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4109
4165
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4110
4166
|
|
4111
4167
|
attr_accessor :Operator, :ReportId, :Agent
|
@@ -4134,11 +4190,12 @@ module TencentCloud
|
|
4134
4190
|
# @param ReportUrl: 出证报告PDF的下载 URL
|
4135
4191
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
4136
4192
|
# @type ReportUrl: String
|
4137
|
-
# @param Status:
|
4138
|
-
|
4139
|
-
# EvidenceStatusExecuting
|
4140
|
-
# EvidenceStatusSuccess
|
4141
|
-
# EvidenceStatusFailed
|
4193
|
+
# @param Status: 签署报告出证任务的状态
|
4194
|
+
# <ul>
|
4195
|
+
# <li>EvidenceStatusExecuting : 出证任务在执行中</li>
|
4196
|
+
# <li>EvidenceStatusSuccess : 出证任务执行成功</li>
|
4197
|
+
# <li>EvidenceStatusFailed : 出证任务执行失败</li>
|
4198
|
+
# </ul>
|
4142
4199
|
# @type Status: String
|
4143
4200
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
4144
4201
|
# @type RequestId: String
|
@@ -5031,27 +5088,28 @@ module TencentCloud
|
|
5031
5088
|
end
|
5032
5089
|
end
|
5033
5090
|
|
5034
|
-
#
|
5091
|
+
# 扩展服务开通和授权的详细信息
|
5035
5092
|
class ExtendAuthInfo < TencentCloud::Common::AbstractModel
|
5036
|
-
# @param Type:
|
5037
|
-
# OPEN_SERVER_SIGN
|
5038
|
-
# OVERSEA_SIGN
|
5039
|
-
# MOBILE_CHECK_APPROVER
|
5040
|
-
# PAGING_SEAL
|
5041
|
-
# BATCH_SIGN
|
5093
|
+
# @param Type: 扩展服务的类型,可能是以下值:
|
5094
|
+
# <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
|
5095
|
+
# <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
|
5096
|
+
# <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
|
5097
|
+
# <li>PAGING_SEAL:骑缝章</li>
|
5098
|
+
# <li>BATCH_SIGN:批量签署</li></ul>
|
5042
5099
|
# @type Type: String
|
5043
|
-
# @param Name:
|
5100
|
+
# @param Name: 扩展服务的名称
|
5044
5101
|
# @type Name: String
|
5045
|
-
# @param Status:
|
5102
|
+
# @param Status: 扩展服务的开通状态:
|
5103
|
+
# ENABLE:开通
|
5046
5104
|
# DISABLE:未开通
|
5047
5105
|
# @type Status: String
|
5048
|
-
# @param OperatorUserId:
|
5106
|
+
# @param OperatorUserId: 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
5049
5107
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5050
5108
|
# @type OperatorUserId: String
|
5051
|
-
# @param OperateOn:
|
5109
|
+
# @param OperateOn: 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
|
5052
5110
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5053
5111
|
# @type OperateOn: Integer
|
5054
|
-
# @param HasAuthUserList:
|
5112
|
+
# @param HasAuthUserList: 该扩展服务若可以授权,此参数对应授权人员的列表
|
5055
5113
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5056
5114
|
# @type HasAuthUserList: Array
|
5057
5115
|
|
@@ -5388,10 +5446,13 @@ module TencentCloud
|
|
5388
5446
|
# @param OrganizationName: 签署方企业名称
|
5389
5447
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5390
5448
|
# @type OrganizationName: String
|
5449
|
+
# @param SignId: 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
|
5450
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
5451
|
+
# @type SignId: String
|
5391
5452
|
|
5392
|
-
attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName
|
5453
|
+
attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName, :SignId
|
5393
5454
|
|
5394
|
-
def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil)
|
5455
|
+
def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil, signid=nil)
|
5395
5456
|
@ApproveMessage = approvemessage
|
5396
5457
|
@ApproveName = approvename
|
5397
5458
|
@ApproveStatus = approvestatus
|
@@ -5405,6 +5466,7 @@ module TencentCloud
|
|
5405
5466
|
@CustomApproverTag = customapprovertag
|
5406
5467
|
@OrganizationId = organizationid
|
5407
5468
|
@OrganizationName = organizationname
|
5469
|
+
@SignId = signid
|
5408
5470
|
end
|
5409
5471
|
|
5410
5472
|
def deserialize(params)
|
@@ -5421,15 +5483,20 @@ module TencentCloud
|
|
5421
5483
|
@CustomApproverTag = params['CustomApproverTag']
|
5422
5484
|
@OrganizationId = params['OrganizationId']
|
5423
5485
|
@OrganizationName = params['OrganizationName']
|
5486
|
+
@SignId = params['SignId']
|
5424
5487
|
end
|
5425
5488
|
end
|
5426
5489
|
|
5427
5490
|
# 签署链接信息
|
5428
5491
|
class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
|
5429
|
-
# @param SignUrl:
|
5492
|
+
# @param SignUrl: 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
|
5493
|
+
# 注: `注意该链接有效期为30分钟`
|
5430
5494
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5431
5495
|
# @type SignUrl: String
|
5432
|
-
# @param ApproverType:
|
5496
|
+
# @param ApproverType: 签署参与人类型
|
5497
|
+
# <ul><li> **1** :个人参与方</li></ul>
|
5498
|
+
|
5499
|
+
# 注: `现在仅支持个人参与方`
|
5433
5500
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5434
5501
|
# @type ApproverType: Integer
|
5435
5502
|
# @param ApproverName: 签署人姓名
|
@@ -5438,7 +5505,8 @@ module TencentCloud
|
|
5438
5505
|
# @param ApproverMobile: 签署人手机号
|
5439
5506
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5440
5507
|
# @type ApproverMobile: String
|
5441
|
-
# @param LongUrl:
|
5508
|
+
# @param LongUrl: 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
|
5509
|
+
# 注: `注意该链接有效期为30分钟`
|
5442
5510
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5443
5511
|
# @type LongUrl: String
|
5444
5512
|
|
@@ -6259,14 +6327,14 @@ module TencentCloud
|
|
6259
6327
|
end
|
6260
6328
|
end
|
6261
6329
|
|
6262
|
-
#
|
6330
|
+
# 被授权的用户信息
|
6263
6331
|
class HasAuthUser < TencentCloud::Common::AbstractModel
|
6264
|
-
# @param UserId:
|
6332
|
+
# @param UserId: 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
6265
6333
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6266
6334
|
# @type UserId: String
|
6267
|
-
# @param BelongTo:
|
6268
|
-
# MainOrg
|
6269
|
-
# CurrentOrg
|
6335
|
+
# @param BelongTo: 当前员工的归属情况,可能值是:
|
6336
|
+
# MainOrg:在集团企业的场景下,返回此值代表是归属主企业
|
6337
|
+
# CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
|
6270
6338
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
6271
6339
|
# @type BelongTo: String
|
6272
6340
|
|
@@ -6398,13 +6466,17 @@ module TencentCloud
|
|
6398
6466
|
|
6399
6467
|
# ModifyApplicationCallbackInfo请求参数结构体
|
6400
6468
|
class ModifyApplicationCallbackInfoRequest < TencentCloud::Common::AbstractModel
|
6401
|
-
# @param Operator:
|
6469
|
+
# @param Operator: 执行本接口操作的员工信息。
|
6470
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
6402
6471
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
6403
|
-
# @param OperateType: 操作类型:
|
6472
|
+
# @param OperateType: 操作类型:
|
6473
|
+
# 1-新增
|
6474
|
+
# 2-删除
|
6404
6475
|
# @type OperateType: Integer
|
6405
|
-
# @param CallbackInfo:
|
6476
|
+
# @param CallbackInfo: 企业应用回调信息
|
6406
6477
|
# @type CallbackInfo: :class:`Tencentcloud::Ess.v20201111.models.CallbackInfo`
|
6407
|
-
# @param Agent:
|
6478
|
+
# @param Agent: 代理企业和员工的信息。
|
6479
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
6408
6480
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
6409
6481
|
|
6410
6482
|
attr_accessor :Operator, :OperateType, :CallbackInfo, :Agent
|
@@ -7168,13 +7240,14 @@ module TencentCloud
|
|
7168
7240
|
end
|
7169
7241
|
end
|
7170
7242
|
|
7171
|
-
#
|
7243
|
+
# 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
|
7172
7244
|
class SignQrCode < TencentCloud::Common::AbstractModel
|
7173
|
-
# @param QrCodeId: 二维码
|
7245
|
+
# @param QrCodeId: 二维码ID,为32位字符串。
|
7174
7246
|
# @type QrCodeId: String
|
7175
|
-
# @param QrCodeUrl: 二维码
|
7247
|
+
# @param QrCodeUrl: 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
|
7176
7248
|
# @type QrCodeUrl: String
|
7177
|
-
# @param ExpiredTime:
|
7249
|
+
# @param ExpiredTime: 二维码的有截止时间,格式为Unix标准时间戳(秒)。
|
7250
|
+
# 一旦超过二维码的有效期限,该二维码将自动失效。
|
7178
7251
|
# @type ExpiredTime: Integer
|
7179
7252
|
|
7180
7253
|
attr_accessor :QrCodeId, :QrCodeUrl, :ExpiredTime
|
@@ -7192,13 +7265,16 @@ module TencentCloud
|
|
7192
7265
|
end
|
7193
7266
|
end
|
7194
7267
|
|
7195
|
-
#
|
7268
|
+
# 流程签署二维码的签署信息,适用于客户系统整合二维码功能。
|
7269
|
+
# 通过链接,用户可直接访问电子签名小程序并签署合同。
|
7196
7270
|
class SignUrl < TencentCloud::Common::AbstractModel
|
7197
|
-
# @param AppSignUrl:
|
7271
|
+
# @param AppSignUrl: 跳转至电子签名小程序签署的链接地址。
|
7272
|
+
# 适用于客户端APP及小程序直接唤起电子签名小程序。
|
7198
7273
|
# @type AppSignUrl: String
|
7199
|
-
# @param EffectiveTime:
|
7274
|
+
# @param EffectiveTime: 签署链接有效时间,格式类似"2022-08-05 15:55:01"
|
7200
7275
|
# @type EffectiveTime: String
|
7201
|
-
# @param HttpSignUrl:
|
7276
|
+
# @param HttpSignUrl: 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。
|
7277
|
+
# 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
|
7202
7278
|
# @type HttpSignUrl: String
|
7203
7279
|
|
7204
7280
|
attr_accessor :AppSignUrl, :EffectiveTime, :HttpSignUrl
|
@@ -7334,22 +7410,26 @@ module TencentCloud
|
|
7334
7410
|
|
7335
7411
|
# StartFlow请求参数结构体
|
7336
7412
|
class StartFlowRequest < TencentCloud::Common::AbstractModel
|
7337
|
-
# @param Operator:
|
7413
|
+
# @param Operator: 执行本接口操作的员工信息。
|
7414
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
7338
7415
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
7339
|
-
# @param FlowId:
|
7416
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
7417
|
+
# 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
|
7340
7418
|
# @type FlowId: String
|
7341
7419
|
# @param ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
|
7342
7420
|
# @type ClientToken: String
|
7343
|
-
# @param Agent:
|
7421
|
+
# @param Agent: 代理企业和员工的信息。
|
7422
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
7344
7423
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
7345
|
-
# @param CcNotifyType:
|
7346
|
-
|
7347
|
-
#
|
7348
|
-
|
7349
|
-
# 1-签署完成后通知
|
7424
|
+
# @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
|
7425
|
+
# 0 - 合同发起时通知(默认)
|
7426
|
+
# 1 - 签署完成后通知
|
7350
7427
|
# @type CcNotifyType: Integer
|
7351
7428
|
|
7352
7429
|
attr_accessor :Operator, :FlowId, :ClientToken, :Agent, :CcNotifyType
|
7430
|
+
extend Gem::Deprecate
|
7431
|
+
deprecate :ClientToken, :none, 2023, 9
|
7432
|
+
deprecate :ClientToken=, :none, 2023, 9
|
7353
7433
|
|
7354
7434
|
def initialize(operator=nil, flowid=nil, clienttoken=nil, agent=nil, ccnotifytype=nil)
|
7355
7435
|
@Operator = operator
|
@@ -7376,13 +7456,10 @@ module TencentCloud
|
|
7376
7456
|
|
7377
7457
|
# StartFlow返回参数结构体
|
7378
7458
|
class StartFlowResponse < TencentCloud::Common::AbstractModel
|
7379
|
-
# @param Status:
|
7380
|
-
|
7381
|
-
#
|
7382
|
-
|
7383
|
-
# REVIEW-提交审核成功,
|
7384
|
-
|
7385
|
-
# EXECUTING-已提交发起任务
|
7459
|
+
# @param Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
|
7460
|
+
# START - 发起成功
|
7461
|
+
# REVIEW - 提交审核成功
|
7462
|
+
# EXECUTING - 已提交发起任务
|
7386
7463
|
# @type Status: String
|
7387
7464
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
7388
7465
|
# @type RequestId: String
|
@@ -7931,14 +8008,18 @@ module TencentCloud
|
|
7931
8008
|
|
7932
8009
|
# 用户的三要素:姓名,证件号,证件类型
|
7933
8010
|
class UserThreeFactor < TencentCloud::Common::AbstractModel
|
7934
|
-
# @param Name:
|
8011
|
+
# @param Name: 签署方经办人的姓名。
|
8012
|
+
# 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
7935
8013
|
# @type Name: String
|
7936
|
-
# @param IdCardType:
|
7937
|
-
# ID_CARD
|
7938
|
-
# HONGKONG_AND_MACAO
|
7939
|
-
# HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
8014
|
+
# @param IdCardType: 证件类型,支持以下类型
|
8015
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
8016
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
8017
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
7940
8018
|
# @type IdCardType: String
|
7941
|
-
# @param IdCardNumber:
|
8019
|
+
# @param IdCardNumber: 证件号码,应符合以下规则
|
8020
|
+
# <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
8021
|
+
# <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
8022
|
+
# <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
7942
8023
|
# @type IdCardNumber: String
|
7943
8024
|
|
7944
8025
|
attr_accessor :Name, :IdCardType, :IdCardNumber
|
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.654
|
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-09-
|
11
|
+
date: 2023-09-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: tencentcloud-sdk-common
|
@@ -33,8 +33,8 @@ executables: []
|
|
33
33
|
extensions: []
|
34
34
|
extra_rdoc_files: []
|
35
35
|
files:
|
36
|
-
- lib/v20201111/client.rb
|
37
36
|
- lib/v20201111/models.rb
|
37
|
+
- lib/v20201111/client.rb
|
38
38
|
- lib/tencentcloud-sdk-ess.rb
|
39
39
|
- lib/VERSION
|
40
40
|
homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
|